es-toolkit 1.9.0 → 1.10.0-dev.204

package/dist/chunk-XPSOKBRZ.mjs

@@ -0,0 +1,12 @@
+// src/array/initial.ts
+function initial(arr) {
+  if (arr.length <= 1) {
+    return [];
+  }
+  return arr.slice(0, -1);
+}
+
+export {
+  initial
+};
+//# sourceMappingURL=chunk-XPSOKBRZ.mjs.map

package/dist/chunk-XPSOKBRZ.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/array/initial.ts"],"sourcesContent":["/**\n * Returns a new array containing all elements except the last one from the input array.\n * If the input array is empty or has only one element, the function returns an empty array.\n *\n * @template T The type of elements in the array.\n * @param {T[]} arr - The input array to query.\n * @returns {T[]} A new array containing all but the last element of the input array.\n *\n * @example\n * const arr = [1, 2, 3, 4];\n * const newArr = initial(arr);\n * // newArr will be [1, 2, 3]\n *\n * @example\n * const emptyArr: number[] = [];\n * const newEmptyArr = initial(emptyArr);\n * // newEmptyArr will be []\n *\n * @example\n * const singleElementArr = ['only one'];\n * const newSingleElementArr = initial(singleElementArr);\n * // newSingleElementArr will be []\n */\nexport function initial<T>(arr: T[]): T[] {\n  if (arr.length <= 1) {\n    return [];\n  }\n  return arr.slice(0, -1);\n}\n"],"mappings":";AAuBO,SAAS,QAAW,KAAe;AACxC,MAAI,IAAI,UAAU,GAAG;AACnB,WAAO,CAAC;AAAA,EACV;AACA,SAAO,IAAI,MAAM,GAAG,EAAE;AACxB;","names":[]}

package/dist/compat/index.d.mts

@@ -0,0 +1,108 @@
+export { compact } from '../array/compact.mjs';
+export { countBy } from '../array/countBy.mjs';
+export { difference } from '../array/difference.mjs';
+export { differenceBy } from '../array/differenceBy.mjs';
+export { differenceWith } from '../array/differenceWith.mjs';
+export { drop } from '../array/drop.mjs';
+export { dropRight } from '../array/dropRight.mjs';
+export { dropRightWhile } from '../array/dropRightWhile.mjs';
+export { dropWhile } from '../array/dropWhile.mjs';
+export { fill } from '../array/fill.mjs';
+export { flatten } from '../array/flatten.mjs';
+export { flattenDeep } from '../array/flattenDeep.mjs';
+export { forEachRight } from '../array/forEachRight.mjs';
+export { groupBy } from '../array/groupBy.mjs';
+export { intersection } from '../array/intersection.mjs';
+export { intersectionBy } from '../array/intersectionBy.mjs';
+export { intersectionWith } from '../array/intersectionWith.mjs';
+export { keyBy } from '../array/keyBy.mjs';
+export { maxBy } from '../array/maxBy.mjs';
+export { minBy } from '../array/minBy.mjs';
+export { orderBy } from '../array/orderBy.mjs';
+export { partition } from '../array/partition.mjs';
+export { sample } from '../array/sample.mjs';
+export { sampleSize } from '../array/sampleSize.mjs';
+export { shuffle } from '../array/shuffle.mjs';
+export { take } from '../array/take.mjs';
+export { takeRight } from '../array/takeRight.mjs';
+export { takeRightWhile } from '../array/takeRightWhile.mjs';
+export { takeWhile } from '../array/takeWhile.mjs';
+export { union } from '../array/union.mjs';
+export { unionBy } from '../array/unionBy.mjs';
+export { unionWith } from '../array/unionWith.mjs';
+export { uniq } from '../array/uniq.mjs';
+export { uniqBy } from '../array/uniqBy.mjs';
+export { uniqWith } from '../array/uniqWith.mjs';
+export { unzip } from '../array/unzip.mjs';
+export { unzipWith } from '../array/unzipWith.mjs';
+export { xor } from '../array/xor.mjs';
+export { xorBy } from '../array/xorBy.mjs';
+export { xorWith } from '../array/xorWith.mjs';
+export { zip } from '../array/zip.mjs';
+export { zipObject } from '../array/zipObject.mjs';
+export { zipWith } from '../array/zipWith.mjs';
+export { without } from '../array/without.mjs';
+export { head } from '../array/head.mjs';
+export { tail } from '../array/tail.mjs';
+export { toFilled } from '../array/toFilled.mjs';
+export { last } from '../array/last.mjs';
+export { initial } from '../array/initial.mjs';
+export { AbortError } from '../error/AbortError.mjs';
+export { debounce } from '../function/debounce.mjs';
+export { noop } from '../function/noop.mjs';
+export { once } from '../function/once.mjs';
+export { throttle } from '../function/throttle.mjs';
+export { negate } from '../function/negate.mjs';
+export { clamp } from '../math/clamp.mjs';
+export { inRange } from '../math/inRange.mjs';
+export { mean } from '../math/mean.mjs';
+export { meanBy } from '../math/meanBy.mjs';
+export { random } from '../math/random.mjs';
+export { randomInt } from '../math/randomInt.mjs';
+export { round } from '../math/round.mjs';
+export { sum } from '../math/sum.mjs';
+export { range } from '../math/range.mjs';
+export { omit } from '../object/omit.mjs';
+export { omitBy } from '../object/omitBy.mjs';
+export { pick } from '../object/pick.mjs';
+export { pickBy } from '../object/pickBy.mjs';
+export { invert } from '../object/invert.mjs';
+export { clone } from '../object/clone.mjs';
+export { isEqual } from '../predicate/isEqual.mjs';
+export { isNil } from '../predicate/isNil.mjs';
+export { isNotNil } from '../predicate/isNotNil.mjs';
+export { isNull } from '../predicate/isNull.mjs';
+export { isUndefined } from '../predicate/isUndefined.mjs';
+export { delay } from '../promise/delay.mjs';
+export { camelCase } from '../string/camelCase.mjs';
+export { snakeCase } from '../string/snakeCase.mjs';
+export { kebabCase } from '../string/kebabCase.mjs';
+export { lowerCase } from '../string/lowerCase.mjs';
+export { capitalize } from '../string/capitalize.mjs';
+
+/**
+ * Splits an array into smaller arrays of a specified length.
+ *
+ * This function takes an input array and divides it into multiple smaller arrays,
+ * each of a specified length. If the input array cannot be evenly divided,
+ * the final sub-array will contain the remaining elements.
+ *
+ * @template T The type of elements in the array.
+ * @param {T[]} arr - The array to be chunked into smaller arrays.
+ * @param {number} size - The size of each smaller array. Must be a positive integer.
+ * @returns {T[][]} A two-dimensional array where each sub-array has a maximum length of `size`.
+ * @throws {Error} Throws an error if `size` is not a positive integer.
+ *
+ * @example
+ * // Splits an array of numbers into sub-arrays of length 2
+ * chunk([1, 2, 3, 4, 5], 2);
+ * // Returns: [[1, 2], [3, 4], [5]]
+ *
+ * @example
+ * // Splits an array of strings into sub-arrays of length 3
+ * chunk(['a', 'b', 'c', 'd', 'e', 'f', 'g'], 3);
+ * // Returns: [['a', 'b', 'c'], ['d', 'e', 'f'], ['g']]
+ */
+declare function chunk<T>(arr: readonly T[], size?: number): T[][];
+
+export { chunk };

package/dist/compat/index.d.ts

@@ -0,0 +1,108 @@
+export { compact } from '../array/compact.js';
+export { countBy } from '../array/countBy.js';
+export { difference } from '../array/difference.js';
+export { differenceBy } from '../array/differenceBy.js';
+export { differenceWith } from '../array/differenceWith.js';
+export { drop } from '../array/drop.js';
+export { dropRight } from '../array/dropRight.js';
+export { dropRightWhile } from '../array/dropRightWhile.js';
+export { dropWhile } from '../array/dropWhile.js';
+export { fill } from '../array/fill.js';
+export { flatten } from '../array/flatten.js';
+export { flattenDeep } from '../array/flattenDeep.js';
+export { forEachRight } from '../array/forEachRight.js';
+export { groupBy } from '../array/groupBy.js';
+export { intersection } from '../array/intersection.js';
+export { intersectionBy } from '../array/intersectionBy.js';
+export { intersectionWith } from '../array/intersectionWith.js';
+export { keyBy } from '../array/keyBy.js';
+export { maxBy } from '../array/maxBy.js';
+export { minBy } from '../array/minBy.js';
+export { orderBy } from '../array/orderBy.js';
+export { partition } from '../array/partition.js';
+export { sample } from '../array/sample.js';
+export { sampleSize } from '../array/sampleSize.js';
+export { shuffle } from '../array/shuffle.js';
+export { take } from '../array/take.js';
+export { takeRight } from '../array/takeRight.js';
+export { takeRightWhile } from '../array/takeRightWhile.js';
+export { takeWhile } from '../array/takeWhile.js';
+export { union } from '../array/union.js';
+export { unionBy } from '../array/unionBy.js';
+export { unionWith } from '../array/unionWith.js';
+export { uniq } from '../array/uniq.js';
+export { uniqBy } from '../array/uniqBy.js';
+export { uniqWith } from '../array/uniqWith.js';
+export { unzip } from '../array/unzip.js';
+export { unzipWith } from '../array/unzipWith.js';
+export { xor } from '../array/xor.js';
+export { xorBy } from '../array/xorBy.js';
+export { xorWith } from '../array/xorWith.js';
+export { zip } from '../array/zip.js';
+export { zipObject } from '../array/zipObject.js';
+export { zipWith } from '../array/zipWith.js';
+export { without } from '../array/without.js';
+export { head } from '../array/head.js';
+export { tail } from '../array/tail.js';
+export { toFilled } from '../array/toFilled.js';
+export { last } from '../array/last.js';
+export { initial } from '../array/initial.js';
+export { AbortError } from '../error/AbortError.js';
+export { debounce } from '../function/debounce.js';
+export { noop } from '../function/noop.js';
+export { once } from '../function/once.js';
+export { throttle } from '../function/throttle.js';
+export { negate } from '../function/negate.js';
+export { clamp } from '../math/clamp.js';
+export { inRange } from '../math/inRange.js';
+export { mean } from '../math/mean.js';
+export { meanBy } from '../math/meanBy.js';
+export { random } from '../math/random.js';
+export { randomInt } from '../math/randomInt.js';
+export { round } from '../math/round.js';
+export { sum } from '../math/sum.js';
+export { range } from '../math/range.js';
+export { omit } from '../object/omit.js';
+export { omitBy } from '../object/omitBy.js';
+export { pick } from '../object/pick.js';
+export { pickBy } from '../object/pickBy.js';
+export { invert } from '../object/invert.js';
+export { clone } from '../object/clone.js';
+export { isEqual } from '../predicate/isEqual.js';
+export { isNil } from '../predicate/isNil.js';
+export { isNotNil } from '../predicate/isNotNil.js';
+export { isNull } from '../predicate/isNull.js';
+export { isUndefined } from '../predicate/isUndefined.js';
+export { delay } from '../promise/delay.js';
+export { camelCase } from '../string/camelCase.js';
+export { snakeCase } from '../string/snakeCase.js';
+export { kebabCase } from '../string/kebabCase.js';
+export { lowerCase } from '../string/lowerCase.js';
+export { capitalize } from '../string/capitalize.js';
+
+/**
+ * Splits an array into smaller arrays of a specified length.
+ *
+ * This function takes an input array and divides it into multiple smaller arrays,
+ * each of a specified length. If the input array cannot be evenly divided,
+ * the final sub-array will contain the remaining elements.
+ *
+ * @template T The type of elements in the array.
+ * @param {T[]} arr - The array to be chunked into smaller arrays.
+ * @param {number} size - The size of each smaller array. Must be a positive integer.
+ * @returns {T[][]} A two-dimensional array where each sub-array has a maximum length of `size`.
+ * @throws {Error} Throws an error if `size` is not a positive integer.
+ *
+ * @example
+ * // Splits an array of numbers into sub-arrays of length 2
+ * chunk([1, 2, 3, 4, 5], 2);
+ * // Returns: [[1, 2], [3, 4], [5]]
+ *
+ * @example
+ * // Splits an array of strings into sub-arrays of length 3
+ * chunk(['a', 'b', 'c', 'd', 'e', 'f', 'g'], 3);
+ * // Returns: [['a', 'b', 'c'], ['d', 'e', 'f'], ['g']]
+ */
+declare function chunk<T>(arr: readonly T[], size?: number): T[][];
+
+export { chunk };