Function ensure

ensure<T, Args>(checkFn, errorMsg?): ((value, ...args) => T)
Determines if a value is a number.
Type Parameters
- T
- Args extends readonly unknown[] = []
Parameters
- checkFn: ((value, ...args) => value is T)
  function to check the value
  - - (value, ...args): value is T
    - Parameters
      value: any
      Rest ...args: Args
      Returns value is T
- Optional errorMsg: string
  error message to throw if the value does not match the expected type
Returns ((value, ...args) => T)
a function that checks if a value matches the expected type
- - (value, ...args): T
  - Parameters
    - value: unknown
    - Rest ...args: Args
    Returns T
Example
```
const ensureArr = ensure(isArr, 'Value is not an array')
const arr = ensureArr(123) // throws an error
const arr2 = ensureArr([1, 2, 3]) // returns [1, 2, 3]
```
- Defined in fn-ops.ts:13
ensure<T, Args>(checkFn, errorMsg?): ((value, ...args) => T)
Type Parameters
- T
- Args extends readonly unknown[] = []
Parameters
- checkFn: ((value, ...args) => boolean)
  - - (value, ...args): boolean
    - Parameters
      value: T
      Rest ...args: Args
      Returns boolean
- Optional errorMsg: string
Returns ((value, ...args) => T)
- - (value, ...args): T
  - Parameters
    - value: T
    - Rest ...args: Args
    Returns T
- Defined in fn-ops.ts:17

Generated using TypeDoc