File size: 4,231 Bytes
bc20498 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
import { dequal as deepEqual } from 'dequal';
/**
* Returns the element some number before the given index. If the target index is out of bounds:
* - If looping is disabled, the first element will be returned.
* - If looping is enabled, the last element will be returned.
* @param array the array.
* @param currentIndex the index of the current element.
* @param increment the number of elements to move forward.
* @param loop loop to the beginning of the array if the target index is out of bounds?
*/
export function back(array, index, increment, loop = true) {
const previousIndex = index - increment;
if (previousIndex <= 0) {
return loop ? array[array.length - 1] : array[0];
}
return array[previousIndex];
}
/**
* Returns the element some number after the given index. If the target index is out of bounds:
* - If looping is disabled, the last element will be returned.
* - If looping is enabled, the first element will be returned.
* @param array the array.
* @param currentIndex the index of the current element.
* @param increment the number of elements to move forward.
* @param loop loop to the beginning of the array if the target index is out of bounds?
*/
export function forward(array, index, increment, loop = true) {
const nextIndex = index + increment;
if (nextIndex > array.length - 1) {
return loop ? array[0] : array[array.length - 1];
}
return array[nextIndex];
}
/**
* Returns the array element after to the given index.
* @param array the array.
* @param currentIndex the index of the current element.
* @param loop loop to the beginning of the array if the next index is out of bounds?
*/
export function next(array, index, loop = true) {
if (index === array.length - 1) {
return loop ? array[0] : array[index];
}
return array[index + 1];
}
/**
* Returns the array element prior to the given index.
* @param array the array.
* @param currentIndex the index of the current element.
* @param loop loop to the end of the array if the previous index is out of bounds?
*/
export function prev(array, currentIndex, loop = true) {
if (currentIndex <= 0) {
return loop ? array[array.length - 1] : array[0];
}
return array[currentIndex - 1];
}
/**
* Returns the last element in an array.
* @param array the array.
*/
export function last(array) {
return array[array.length - 1];
}
/**
* Wraps an array around itself at a given starting index.
* @example ```ts
* wrapArray(['a', 'b', 'c', 'd'], 2);
* // ['c', 'd', 'a', 'b']
* ```
* @see https://github.com/radix-ui/primitives
*/
export function wrapArray(array, startIndex) {
return array.map((_, index) => array[(startIndex + index) % array.length]);
}
/**
* Toggles an item in an array. If the item is already in the array,
* it is removed. Otherwise, it is added.
* @param item The item to toggle.
* @param array The array to toggle the item in.
* @returns The updated array with the item toggled.
* @template T The type of the items in the array.
* @example ```typescript
* const arr = [1, 2, 3];
* const newArr = toggle(2, arr);
* // newArr = [1, 3]
* ```
*/
export function toggle(item, array, compare = deepEqual) {
const itemIdx = array.findIndex((innerItem) => compare(innerItem, item));
if (itemIdx !== -1) {
array.splice(itemIdx, 1);
}
else {
array.push(item);
}
return array;
}
/**
* Splits an array into chunks of a given size.
* @param arr The array to split.
* @param size The size of each chunk.
* @returns An array of arrays, where each sub-array has `size` elements from the original array.
* @example ```ts
* const arr = [1, 2, 3, 4, 5, 6, 7, 8];
* const chunks = chunk(arr, 3);
* // chunks = [[1, 2, 3], [4, 5, 6], [7, 8]]
* ```
*/
export function chunk(arr, size) {
const result = [];
for (let i = 0; i < arr.length; i += size) {
result.push(arr.slice(i, i + size));
}
return result;
}
/**
* Checks if the given index is valid for the given array.
*
* @param index - The index to check
* @param arr - The array to check
*/
export function isValidIndex(index, arr) {
return index >= 0 && index < arr.length;
}
|