Skip to main content

Function: enforceArray()

enforceArray<T>(value): T[]

Defined in: utilities/enforce-array.ts:19

Ensures that the provided value is returned as an array.

If the value is already an array, it is returned as-is. If the value is not an array, it is wrapped in an array. If the value is null or undefined, an empty array is returned.

Type Parameters​

T​

T

The type of the array elements.

Parameters​

value​

The value to ensure as an array.

undefined | null | T | T[]

Returns​

T[]

The value as an array.

Example​

enforceArray(5); // returns [5]
enforceArray([5]); // returns [5]
enforceArray('hello'); // returns ['hello']
enforceArray(true); // returns [true]
enforceArray({ a: 1 }); // returns [{ a: 1 }]
enforceArray(null); // returns []
enforceArray(undefined); // returns []