Utilities
![JavaScript Style Guide](https://camo.githubusercontent.com/ff3e730c1c3401d5a6628d17368fa46e566da747c2b85de971e228c44426dbee/68747470733a2f2f63646e2e7261776769742e636f6d2f7374616e646172642f7374616e646172642f6d61737465722f62616467652e737667)
Table of Contents
Install
npm i @neumatter/utilities
Usage
Import
import * as utilities from '@neumatter/utilities'
// use utilities
utilities.getCasePattern
:
utilities.getCasePattern(input: string): ByteView
utilities.applyCasePattern
:
utilities.applyCasePattern(input: string, pattern: ByteView): string
utilities.throwIfNotWithin
:
utilities.throwIfNotWithin<T extends any>(
value: T,
availableValues?: Array<T>
): void
utilities.throwIfNoInstanceOf
:
utilities.throwIfNoInstanceOf<T extends any>(
value: T,
availableValues?: Array<typeof T>
): void
utilities.assertObject
:
utilities.assertObject<T extends object>(
input: T,
paramName: string
): void
utilities.assertString
:
utilities.assertString(input: string, paramName: string): void
utilities.assertFunction
:
utilities.assertFunction(input: Function, paramName: string): void
utilities.assertNumber
:
utilities.assertNumber(input: number, paramName: string): void
utilities.assertFiniteNumber
:
utilities.assertFiniteNumber(input: number, paramName: string): void
utilities.getObjectOption
:
utilities.getObjectOption<O extends object, T>(
opts: O,
prop: keyof O,
values?: Array<any>,
fallback: T
): T
utilities.getBooleanOption
:
utilities.getBooleanOption<O extends object>(
opts: O,
prop: keyof O,
fallback: boolean
): boolean
utilities.getStringOption
:
utilities.getStringOption<O extends object>(
opts: O,
prop: keyof O,
values?: Array<string>,
fallback: string
): string
utilities.defaultNumberOption
:
utilities.defaultNumberOption(
val: number,
min: number,
max: number,
fallback: number
): number
utilities.getNumberOption
:
utilities.getNumberOption<O extends object>(
options: O,
property: keyof O,
minimum: number,
maximum: number,
fallback: number
): number
utilities.defaultIntegerOption
:
utilities.defaultIntegerOption(
val: number,
min: number,
max: number,
fallback: number
): number
utilities.getIntegerOption
:
utilities.getIntegerOption<O extends object>(
options: O,
property: keyof O,
minimum: number,
maximum: number,
fallback: number
): number