30 lines
773 B
TypeScript
30 lines
773 B
TypeScript
|
//#region src/compat/array/castArray.d.ts
|
||
|
|
/**
|
||
|
|
* Casts value as an array if it's not one.
|
||
|
|
*
|
||
|
|
* @template T The type of elements in the array.
|
||
|
|
* @param {T | T[]} value The value to be cast to an array.
|
||
|
|
* @returns {T[]} An array containing the input value if it wasn't an array, or the original array if it was.
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* const arr1 = castArray(1);
|
||
|
|
* // Returns: [1]
|
||
|
|
*
|
||
|
|
* const arr2 = castArray([1]);
|
||
|
|
* // Returns: [1]
|
||
|
|
*
|
||
|
|
* const arr3 = castArray({'a': 1});
|
||
|
|
* // Returns: [{'a': 1}]
|
||
|
|
*
|
||
|
|
* const arr4 = castArray(null);
|
||
|
|
* // Returns: [null]
|
||
|
|
*
|
||
|
|
* const arr5 = castArray(undefined);
|
||
|
|
* // Returns: [undefined]
|
||
|
|
*
|
||
|
|
* const arr6 = castArray();
|
||
|
|
* // Returns: []
|
||
|
|
*/
|
||
|
|
declare function castArray<T>(value?: T | readonly T[]): T[];
|
||
|
|
//#endregion
|
||
|
|
export { castArray };
|