Assert
Helper functions that have to do with asserting.
Functions
assertArray()
function assertArray(value, msg): asserts value is unknown[];
Defined in: functions/assert.ts:12
Helper function to throw an error if the provided value is not an array.
Parameters
| Parameter | Type |
|---|---|
value | unknown |
msg | string |
Returns
asserts value is unknown[]
assertArrayBoolean()
function assertArrayBoolean(value, msg): asserts value is unknown[];
Defined in: functions/assert.ts:25
Helper function to throw an error if the provided value is not an array with every element being a boolean.
Parameters
| Parameter | Type |
|---|---|
value | unknown |
msg | string |
Returns
asserts value is unknown[]
assertArrayNumber()
function assertArrayNumber(value, msg): asserts value is unknown[];
Defined in: functions/assert.ts:40
Helper function to throw an error if the provided value is not an array with every element being a number.
Parameters
| Parameter | Type |
|---|---|
value | unknown |
msg | string |
Returns
asserts value is unknown[]
assertArrayString()
function assertArrayString(value, msg): asserts value is unknown[];
Defined in: functions/assert.ts:55
Helper function to throw an error if the provided value is not an array with every element being a string.
Parameters
| Parameter | Type |
|---|---|
value | unknown |
msg | string |
Returns
asserts value is unknown[]
assertBoolean()
function assertBoolean(value, msg): asserts value is boolean;
Defined in: functions/assert.ts:67
Helper function to throw an error if the provided value is not a boolean.
Parameters
| Parameter | Type |
|---|---|
value | unknown |
msg | string |
Returns
asserts value is boolean
assertDefined()
function assertDefined<T>(value, ...__namedParameters): asserts value is Exclude<T, undefined>;
Defined in: functions/assert.ts:81
Helper function to throw an error if the provided value is equal to undefined.
This is useful to have TypeScript narrow a T | undefined value to T in a concise way.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
value | T |
...__namedParameters | [undefined] extends [T] ? [string] : ["The assertion is useless because the provided value does not contain undefined."] |
Returns
asserts value is Exclude<T, undefined>
assertEnumValue()
function assertEnumValue<T>(
value,
transpiledEnum,
msg,
set?): asserts value is T[keyof T];
Defined in: functions/assert.ts:104
Helper function to throw an error if the provided value is not contained within an enum.
Type Parameters
| Type Parameter |
|---|
T extends TranspiledEnum |
Parameters
| Parameter | Type | Description |
|---|---|---|
value | string | number | The value to check. |
transpiledEnum | T | The enum to check against. |
msg | string | The error message to throw if the check fails. |
set? | ReadonlySet<string | number> | Optional. A set that contains all of the values of an enum. If provided, this function will check for existence using the set (instead of the enum itself). Using a set should be more performant for enums with around 52 or more elements. |
Returns
asserts value is T[keyof T]
assertIs()
function assertIs<T>(
value,
constructor,
msg): asserts value is InstanceType<T>;
Defined in: functions/assert.ts:120
Helper function to throw an error if the provided value is not an instance of the expected class.
This is useful to have TypeScript narrow a value to a specific type in a concise way.
Type Parameters
| Type Parameter |
|---|
T extends (...args) => unknown |
Parameters
| Parameter | Type |
|---|---|
value | unknown |
constructor | T |
msg | string |
Returns
asserts value is InstanceType<T>
assertNotNull()
function assertNotNull<T>(value, ...__namedParameters): asserts value is Exclude<T, null>;
Defined in: functions/assert.ts:137
Helper function to throw an error if the provided value is equal to null.
This is useful to have TypeScript narrow a T | null value to T in a concise way.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
value | T |
...__namedParameters | [null] extends [T] ? [string] : ["The assertion is useless because the provided value does not contain null."] |
Returns
asserts value is Exclude<T, null>
assertNumber()
function assertNumber(value, msg): asserts value is number;
Defined in: functions/assert.ts:151
Helper function to throw an error if the provided value is not a number.
Parameters
| Parameter | Type |
|---|---|
value | unknown |
msg | string |
Returns
asserts value is number
assertObject()
function assertObject(value, msg): asserts value is Record<string, unknown>;
Defined in: functions/assert.ts:169
Helper function to throw an error if the provided value is not an object (i.e. a TypeScript record).
This is useful to have TypeScript narrow a Record<string, unknown> | undefined value to
Record<string, unknown> in a concise way.
Under the hood, this function uses the isObject helper function.
Parameters
| Parameter | Type |
|---|---|
value | unknown |
msg | string |
Returns
asserts value is Record<string, unknown>
assertString()
function assertString(value, msg): asserts value is string;
Defined in: functions/assert.ts:179
Helper function to throw an error if the provided value is not a string.
Parameters
| Parameter | Type |
|---|---|
value | unknown |
msg | string |
Returns
asserts value is string