93 lines
No EOL
3.6 KiB
TypeScript
93 lines
No EOL
3.6 KiB
TypeScript
//#region src/array/toFilled.d.ts
|
|
/**
|
|
* Creates a new array filled with the specified value from the start position up to, but not including, the end position.
|
|
* This function does not mutate the original array.
|
|
*
|
|
* @template T - The type of elements in the original array.
|
|
* @template U - The type of the value to fill the new array with.
|
|
* @param arr - The array to base the new array on.
|
|
* @param value - The value to fill the new array with.
|
|
* @returns The new array with the filled values.
|
|
*
|
|
* @example
|
|
* const array = [1, 2, 3, 4, 5];
|
|
* let result = toFilled(array, '*', 2);
|
|
* console.log(result); // [1, 2, '*', '*', '*']
|
|
* console.log(array); // [1, 2, 3, 4, 5]
|
|
*
|
|
* result = toFilled(array, '*', 1, 4);
|
|
* console.log(result); // [1, '*', '*', '*', 5]
|
|
* console.log(array); // [1, 2, 3, 4, 5]
|
|
*
|
|
* result = toFilled(array, '*');
|
|
* console.log(result); // ['*', '*', '*', '*', '*']
|
|
* console.log(array); // [1, 2, 3, 4, 5]
|
|
*
|
|
* result = toFilled(array, '*', -4, -1);
|
|
* console.log(result); // [1, '*', '*', '*', 5]
|
|
* console.log(array); // [1, 2, 3, 4, 5]
|
|
*/
|
|
declare function toFilled<T, U>(arr: readonly T[], value: U): Array<T | U>;
|
|
/**
|
|
* Creates a new array filled with the specified value from the start position up to, but not including, the end position.
|
|
* This function does not mutate the original array.
|
|
*
|
|
* @template T - The type of elements in the original array.
|
|
* @template U - The type of the value to fill the new array with.
|
|
* @param arr - The array to base the new array on.
|
|
* @param value - The value to fill the new array with.
|
|
* @param [start=0] - The start position. Defaults to 0.
|
|
* @returns The new array with the filled values.
|
|
*
|
|
* @example
|
|
* const array = [1, 2, 3, 4, 5];
|
|
* let result = toFilled(array, '*', 2);
|
|
* console.log(result); // [1, 2, '*', '*', '*']
|
|
* console.log(array); // [1, 2, 3, 4, 5]
|
|
*
|
|
* result = toFilled(array, '*', 1, 4);
|
|
* console.log(result); // [1, '*', '*', '*', 5]
|
|
* console.log(array); // [1, 2, 3, 4, 5]
|
|
*
|
|
* result = toFilled(array, '*');
|
|
* console.log(result); // ['*', '*', '*', '*', '*']
|
|
* console.log(array); // [1, 2, 3, 4, 5]
|
|
*
|
|
* result = toFilled(array, '*', -4, -1);
|
|
* console.log(result); // [1, '*', '*', '*', 5]
|
|
* console.log(array); // [1, 2, 3, 4, 5]
|
|
*/
|
|
declare function toFilled<T, U>(arr: readonly T[], value: U, start: number): Array<T | U>;
|
|
/**
|
|
* Creates a new array filled with the specified value from the start position up to, but not including, the end position.
|
|
* This function does not mutate the original array.
|
|
*
|
|
* @template T - The type of elements in the original array.
|
|
* @template U - The type of the value to fill the new array with.
|
|
* @param arr - The array to base the new array on.
|
|
* @param value - The value to fill the new array with.
|
|
* @param [start=0] - The start position. Defaults to 0.
|
|
* @param [end=arr.length] - The end position. Defaults to the array's length.
|
|
* @returns The new array with the filled values.
|
|
*
|
|
* @example
|
|
* const array = [1, 2, 3, 4, 5];
|
|
* let result = toFilled(array, '*', 2);
|
|
* console.log(result); // [1, 2, '*', '*', '*']
|
|
* console.log(array); // [1, 2, 3, 4, 5]
|
|
*
|
|
* result = toFilled(array, '*', 1, 4);
|
|
* console.log(result); // [1, '*', '*', '*', 5]
|
|
* console.log(array); // [1, 2, 3, 4, 5]
|
|
*
|
|
* result = toFilled(array, '*');
|
|
* console.log(result); // ['*', '*', '*', '*', '*']
|
|
* console.log(array); // [1, 2, 3, 4, 5]
|
|
*
|
|
* result = toFilled(array, '*', -4, -1);
|
|
* console.log(result); // [1, '*', '*', '*', 5]
|
|
* console.log(array); // [1, 2, 3, 4, 5]
|
|
*/
|
|
declare function toFilled<T, U>(arr: readonly T[], value: U, start: number, end: number): Array<T | U>;
|
|
//#endregion
|
|
export { toFilled }; |