ts-data-forge 3.2.0 → 3.3.1

package/dist/array/impl/array-utils-set-op.mjs

@@ -0,0 +1,137 @@
+/**
+ * Checks if two arrays are equal by comparing their elements.
+ *
+ * @example
+ *
+ * ```ts
+ * const numbers = [1, 2, 3] as const;
+ * const sameNumbers = [1, 2, 3] as const;
+ * const differentNumbers = [1, 2, 4] as const;
+ *
+ * assert.ok(Arr.eq(numbers, sameNumbers));
+ * assert.notOk(Arr.eq(numbers, differentNumbers));
+ * ```
+ */
+const eq = (array1, array2, equality = Object.is) => array1.length === array2.length &&
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    array1.every((v, i) => equality(v, array2[i]));
+/**
+ * Alias for `eq`.
+ *
+ * @see {@link eq}
+ */
+const equal = eq;
+/**
+ * Checks if the first array is a subset of the second array.
+ *
+ * @example
+ *
+ * ```ts
+ * const subset = [1, 2] as const;
+ * const superset = [1, 2, 3] as const;
+ * const notSubset = [2, 4] as const;
+ *
+ * assert.ok(Arr.isSubset(subset, superset));
+ * assert.notOk(Arr.isSubset(notSubset, superset));
+ * ```
+ */
+const isSubset = (array1, array2) => array1.every((a) => 
+// eslint-disable-next-line total-functions/no-unsafe-type-assertion
+array2.includes(a));
+/**
+ * Checks if the first array is a superset of the second array.
+ *
+ * @example
+ *
+ * ```ts
+ * const potentialSuperset = ['a', 'b', 'c'] as const;
+ * const subset = ['a', 'c'] as const;
+ * const notSuperset = ['a', 'd'] as const;
+ *
+ * assert.ok(Arr.isSuperset(potentialSuperset, subset));
+ * assert.notOk(Arr.isSuperset(subset, potentialSuperset));
+ * assert.notOk(Arr.isSuperset(potentialSuperset, notSuperset));
+ * ```
+ */
+const isSuperset = (array1, array2) => isSubset(array2, array1);
+/**
+ * Returns the intersection of two arrays.
+ *
+ * @example
+ *
+ * ```ts
+ * const refs = ['Ada', 'Alan', 'Grace'] as const;
+ * const attendees = ['Grace', 'Alan', 'Barbara'] as const;
+ *
+ * const both = Arr.setIntersection(refs, attendees);
+ *
+ * assert.deepStrictEqual(both, ['Alan', 'Grace']);
+ * ```
+ */
+const setIntersection = (array1, array2) => 
+// eslint-disable-next-line total-functions/no-unsafe-type-assertion
+array1.filter((e) => array2.includes(e));
+/**
+ * Returns the set difference of two arrays (elements in first but not in second).
+ *
+ * @example
+ *
+ * ```ts
+ * const baseline = [1, 2, 3, 4] as const;
+ * const removed = [2, 4] as const;
+ *
+ * const remaining = Arr.setDifference(baseline, removed);
+ *
+ * assert.deepStrictEqual(remaining, [1, 3]);
+ * ```
+ */
+const setDifference = (array1, array2) => array1.filter((e) => !array2.includes(e));
+/**
+ * Returns the set difference of two sorted numeric arrays (optimized for sorted arrays).
+ *
+ * @example
+ *
+ * ```ts
+ * const upcoming = [1, 3, 5, 7, 9] as const;
+ * const completed = [3, 4, 7] as const;
+ *
+ * const remaining = Arr.sortedNumSetDifference(upcoming, completed);
+ *
+ * const expected = [1, 5, 9] as const;
+ *
+ * assert.deepStrictEqual(remaining, expected);
+ * ```
+ */
+const sortedNumSetDifference = (sortedList1, sortedList2) => {
+    const mut_result = [];
+    let mut_it1 = 0; // iterator for sortedList1
+    let mut_it2 = 0; // iterator for sortedList2
+    while (mut_it1 < sortedList1.length && mut_it2 < sortedList2.length) {
+        // Non-null assertions are safe due to loop condition
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const val1 = sortedList1[mut_it1];
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const val2 = sortedList2[mut_it2];
+        if (val1 === val2) {
+            mut_it1 += 1;
+            mut_it2 += 1;
+        }
+        else if (val1 < val2) {
+            mut_result.push(val1);
+            mut_it1 += 1;
+        }
+        else {
+            // val1 > val2
+            mut_it2 += 1;
+        }
+    }
+    // Add remaining elements from sortedList1
+    for (; mut_it1 < sortedList1.length; mut_it1 += 1) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        mut_result.push(sortedList1[mut_it1]);
+    }
+    return mut_result;
+};
+
+export { eq, equal, isSubset, isSuperset, setDifference, setIntersection, sortedNumSetDifference };
+//# sourceMappingURL=array-utils-set-op.mjs.map

package/dist/array/impl/array-utils-set-op.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"array-utils-set-op.mjs","sources":["../../../src/array/impl/array-utils-set-op.mts"],"sourcesContent":[null],"names":[],"mappings":"AAAA;;;;;;;;;;;;;AAaG;MACU,EAAE,GAAG,CAChB,MAAoB,EACpB,MAAoB,EACpB,QAAA,GAAoC,MAAM,CAAC,EAAE,KAE7C,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM;;IAE/B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAE,CAAC;AAEhD;;;;AAIG;AACI,MAAM,KAAK,GAAG;AAErB;;;;;;;;;;;;;AAaG;AACI,MAAM,QAAQ,GAAG,CACtB,MAAqB,EACrB,MAAqB,KAErB,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AACb;AACA,MAAM,CAAC,QAAQ,CAAC,CAAY,CAAC;AAGjC;;;;;;;;;;;;;;AAcG;AACI,MAAM,UAAU,GAAG,CACxB,MAAqB,EACrB,MAAqB,KACT,QAAQ,CAAC,MAAM,EAAE,MAAM;AAErC;;;;;;;;;;;;;AAaG;MACU,eAAe,GAAG,CAI7B,MAAqB,EACrB,MAAqB;AAErB;AACA,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,QAAQ,CAAC,CAAY,CAAC;AAEpD;;;;;;;;;;;;;AAaG;AACI,MAAM,aAAa,GAAG,CAC3B,MAAoB,EACpB,MAAoB,KACH,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;AAE3D;;;;;;;;;;;;;;;AAeG;MACU,sBAAsB,GAAG,CACpC,WAAyB,EACzB,WAAyB,KACT;IAChB,MAAM,UAAU,GAAQ,EAAE;AAC1B,IAAA,IAAI,OAAO,GAAG,CAAC,CAAC;AAChB,IAAA,IAAI,OAAO,GAAG,CAAC,CAAC;AAEhB,IAAA,OAAO,OAAO,GAAG,WAAW,CAAC,MAAM,IAAI,OAAO,GAAG,WAAW,CAAC,MAAM,EAAE;;;AAGnE,QAAA,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAE;;AAElC,QAAA,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAE;AAElC,QAAA,IAAI,IAAI,KAAK,IAAI,EAAE;YACjB,OAAO,IAAI,CAAC;YACZ,OAAO,IAAI,CAAC;QACd;AAAO,aAAA,IAAI,IAAI,GAAG,IAAI,EAAE;AACtB,YAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;YACrB,OAAO,IAAI,CAAC;QACd;aAAO;;YAEL,OAAO,IAAI,CAAC;QACd;IACF;;IAEA,OAAO,OAAO,GAAG,WAAW,CAAC,MAAM,EAAE,OAAO,IAAI,CAAC,EAAE;;QAEjD,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAE,CAAC;IACxC;AAEA,IAAA,OAAO,UAAU;AACnB;;;;"}

package/dist/array/impl/array-utils-size.d.mts

@@ -0,0 +1,24 @@
+/**
+ * Returns the size (length) of an array.
+ *
+ * @example
+ *
+ * ```ts
+ * const numbers = [1, 2, 3] as const;
+ * const letters: string[] = [];
+ *
+ * const sizeOfNumbers = Arr.size(numbers);
+ * const sizeOfLetters = Arr.size(letters);
+ *
+ * assert(sizeOfNumbers === 3);
+ * assert(sizeOfLetters === 0);
+ * ```
+ */
+export declare const size: <const Ar extends readonly unknown[]>(array: Ar) => Ar extends NonEmptyArray<unknown> ? IntersectBrand<PositiveNumber, SizeType.Arr> : SizeType.Arr;
+/**
+ * Alias for `size`.
+ *
+ * @see {@link size}
+ */
+export declare const length: <const Ar extends readonly unknown[]>(array: Ar) => Ar extends NonEmptyArray<unknown> ? IntersectBrand<PositiveNumber, SizeType.Arr> : SizeType.Arr;
+//# sourceMappingURL=array-utils-size.d.mts.map

package/dist/array/impl/array-utils-size.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array-utils-size.d.mts","sourceRoot":"","sources":["../../../src/array/impl/array-utils-size.mts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,IAAI,GAAI,KAAK,CAAC,EAAE,SAAS,SAAS,OAAO,EAAE,EACtD,OAAO,EAAE,KACR,EAAE,SAAS,aAAa,CAAC,OAAO,CAAC,GAChC,cAAc,CAAC,cAAc,EAAE,QAAQ,CAAC,GAAG,CAAC,GAC5C,QAAQ,CAAC,GAEU,CAAC;AAExB;;;;GAIG;AACH,eAAO,MAAM,MAAM,SAbQ,EAAE,SAAS,SAAS,OAAO,EAAE,SAC/C,EAAE,KACR,EAAE,SAAS,aAAa,CAAC,OAAO,CAAC,GAChC,cAAc,CAAC,cAAc,EAAE,QAAQ,CAAC,GAAG,CAAC,GAC5C,QAAQ,CAAC,GASa,CAAC"}

package/dist/array/impl/array-utils-size.mjs

@@ -0,0 +1,28 @@
+/**
+ * Returns the size (length) of an array.
+ *
+ * @example
+ *
+ * ```ts
+ * const numbers = [1, 2, 3] as const;
+ * const letters: string[] = [];
+ *
+ * const sizeOfNumbers = Arr.size(numbers);
+ * const sizeOfLetters = Arr.size(letters);
+ *
+ * assert(sizeOfNumbers === 3);
+ * assert(sizeOfLetters === 0);
+ * ```
+ */
+const size = (array) => 
+// eslint-disable-next-line total-functions/no-unsafe-type-assertion
+array.length;
+/**
+ * Alias for `size`.
+ *
+ * @see {@link size}
+ */
+const length = size;
+
+export { length, size };
+//# sourceMappingURL=array-utils-size.mjs.map

package/dist/array/impl/array-utils-size.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"array-utils-size.mjs","sources":["../../../src/array/impl/array-utils-size.mts"],"sourcesContent":[null],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;AAeG;AACI,MAAM,IAAI,GAAG,CAClB,KAAS;AAIT;AACA,KAAK,CAAC;AAER;;;;AAIG;AACI,MAAM,MAAM,GAAG;;;;"}

package/dist/array/impl/array-utils-slice-clamped.d.mts

@@ -0,0 +1,18 @@
+/**
+ * Slices an array with automatically clamped start and end indices.
+ *
+ * @example
+ *
+ * ```ts
+ * const letters = ['a', 'b', 'c', 'd', 'e'];
+ *
+ * const lastThree = Arr.sliceClamped(letters, -3, 10);
+ * const middleTwo = Arr.sliceClamped(1, 3)(letters);
+ *
+ * assert.deepStrictEqual(lastThree, ['a', 'b', 'c', 'd', 'e']);
+ * assert.deepStrictEqual(middleTwo, ['b', 'c']);
+ * ```
+ */
+export declare function sliceClamped<const Ar extends readonly unknown[]>(array: Ar, start: ArgArrayIndexWithNegative<Ar>, end: ArgArrayIndexWithNegative<Ar>): readonly Ar[number][];
+export declare function sliceClamped(start: SizeType.ArgArrWithNegative, end: SizeType.ArgArrWithNegative): <E>(array: readonly E[]) => readonly E[];
+//# sourceMappingURL=array-utils-slice-clamped.d.mts.map

package/dist/array/impl/array-utils-slice-clamped.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array-utils-slice-clamped.d.mts","sourceRoot":"","sources":["../../../src/array/impl/array-utils-slice-clamped.mts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAAC,KAAK,CAAC,EAAE,SAAS,SAAS,OAAO,EAAE,EAC9D,KAAK,EAAE,EAAE,EACT,KAAK,EAAE,yBAAyB,CAAC,EAAE,CAAC,EACpC,GAAG,EAAE,yBAAyB,CAAC,EAAE,CAAC,GACjC,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;AAEzB,wBAAgB,YAAY,CAC1B,KAAK,EAAE,QAAQ,CAAC,kBAAkB,EAClC,GAAG,EAAE,QAAQ,CAAC,kBAAkB,GAC/B,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC"}

package/dist/array/impl/array-utils-slice-clamped.mjs

@@ -0,0 +1,49 @@
+import '../../number/branded-types/finite-number.mjs';
+import '../../number/branded-types/int.mjs';
+import '../../number/branded-types/int16.mjs';
+import '../../number/branded-types/int32.mjs';
+import '../../number/branded-types/non-negative-finite-number.mjs';
+import '../../number/branded-types/non-negative-int16.mjs';
+import '../../number/branded-types/non-negative-int32.mjs';
+import '../../number/branded-types/non-zero-finite-number.mjs';
+import '../../number/branded-types/non-zero-int.mjs';
+import '../../number/branded-types/non-zero-int16.mjs';
+import '../../number/branded-types/non-zero-int32.mjs';
+import '../../number/branded-types/non-zero-safe-int.mjs';
+import '../../number/branded-types/non-zero-uint16.mjs';
+import '../../number/branded-types/non-zero-uint32.mjs';
+import '../../number/branded-types/positive-finite-number.mjs';
+import '../../number/branded-types/positive-int.mjs';
+import '../../number/branded-types/positive-int16.mjs';
+import '../../number/branded-types/positive-int32.mjs';
+import '../../number/branded-types/positive-safe-int.mjs';
+import '../../number/branded-types/positive-uint16.mjs';
+import '../../number/branded-types/positive-uint32.mjs';
+import '../../number/branded-types/safe-int.mjs';
+import '../../number/branded-types/safe-uint.mjs';
+import '../../number/branded-types/uint.mjs';
+import '../../number/branded-types/uint16.mjs';
+import '../../number/branded-types/uint32.mjs';
+import '../../number/enum/int8.mjs';
+import '../../number/enum/uint8.mjs';
+import { Num } from '../../number/num.mjs';
+import '../../number/refined-number-utils.mjs';
+
+function sliceClamped(...args) {
+    switch (args.length) {
+        case 3: {
+            const [array, start, end] = args;
+            const startClamped = Num.clamp(0, array.length)(start);
+            // Ensure endClamped is not less than startClamped.
+            const endClamped = Num.clamp(startClamped, array.length)(end);
+            return array.slice(startClamped, endClamped);
+        }
+        case 2: {
+            const [start, end] = args;
+            return (array) => sliceClamped(array, start, end);
+        }
+    }
+}
+
+export { sliceClamped };
+//# sourceMappingURL=array-utils-slice-clamped.mjs.map

package/dist/array/impl/array-utils-slice-clamped.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"array-utils-slice-clamped.mjs","sources":["../../../src/array/impl/array-utils-slice-clamped.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BM,SAAU,YAAY,CAC1B,GAAG,IAMoE,EAAA;AAEvE,IAAA,QAAQ,IAAI,CAAC,MAAM;QACjB,KAAK,CAAC,EAAE;YACN,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,IAAI;AAChC,YAAA,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC;;AAEtD,YAAA,MAAM,UAAU,GAAG,GAAG,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC;YAC7D,OAAO,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,UAAU,CAAC;QAC9C;QACA,KAAK,CAAC,EAAE;AACN,YAAA,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,IAAI;AACzB,YAAA,OAAO,CAAC,KAAK,KAAK,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC;QACnD;;AAEJ;;;;"}

package/dist/array/impl/array-utils-slicing.d.mts

@@ -0,0 +1,120 @@
+/**
+ * Returns all elements of an array except the first one.
+ *
+ * @example
+ *
+ * ```ts
+ * {
+ *   const scientists = ['Ada', 'Grace', 'Katherine'] as const;
+ *   const remainder = Arr.tail(scientists);
+ *
+ *   assert.deepStrictEqual(remainder, ['Grace', 'Katherine']);
+ *   assert(remainder.length === 2);
+ * }
+ * {
+ *   const values = [1, 2, 3] as const;
+ *
+ *   const remainder = Arr.rest(values);
+ *   const emptyRemainder = Arr.rest([1] as const);
+ *
+ *   assert.deepStrictEqual(remainder, [2, 3] as const);
+ *   assert.deepStrictEqual(emptyRemainder, [] as const);
+ * }
+ * ```
+ */
+export declare const tail: <const Ar extends readonly unknown[]>(array: Ar) => List.Tail<Ar>;
+/**
+ * Returns all elements of an array except the last one.
+ *
+ * @example
+ *
+ * ```ts
+ * const queue = ['task-1', 'task-2', 'task-3'] as const;
+ * const withoutLast = Arr.butLast(queue);
+ *
+ * assert.deepStrictEqual(withoutLast, ['task-1', 'task-2']);
+ * assert(withoutLast.length === 2);
+ * ```
+ */
+export declare const butLast: <const Ar extends readonly unknown[]>(array: Ar) => List.ButLast<Ar>;
+/**
+ * Takes the first N elements from an array.
+ *
+ * @example
+ *
+ * ```ts
+ * const values = [1, 2, 3, 4];
+ *
+ * const firstTwo = Arr.take(values, 2);
+ * const firstThree = Arr.take(3)(values);
+ *
+ * assert.deepStrictEqual(firstTwo, [1, 2]);
+ * assert.deepStrictEqual(firstThree, [1, 2, 3]);
+ * ```
+ */
+export declare function take<const Ar extends readonly unknown[], N extends SizeType.ArgArr>(array: Ar, num: N): N extends SmallUint ? List.Take<N, Ar> : N extends SizeType.ArgArrPositive ? Ar extends NonEmptyArray<unknown> ? NonEmptyArray<Ar[number]> : readonly Ar[number][] : readonly Ar[number][];
+export declare function take<N extends SizeType.ArgArr>(num: N): <const Ar extends readonly unknown[]>(array: Ar) => N extends SmallUint ? List.Take<N, Ar> : N extends SizeType.ArgArrPositive ? Ar extends NonEmptyArray<unknown> ? NonEmptyArray<Ar[number]> : readonly Ar[number][] : readonly Ar[number][];
+/**
+ * Takes the last N elements from an array.
+ *
+ * @example
+ *
+ * ```ts
+ * const values = [1, 2, 3, 4];
+ *
+ * const lastTwo = Arr.takeLast(values, 2);
+ * const lastThree = Arr.takeLast(3)(values);
+ *
+ * assert.deepStrictEqual(lastTwo, [3, 4]);
+ * assert.deepStrictEqual(lastThree, [2, 3, 4]);
+ * ```
+ */
+export declare function takeLast<const Ar extends readonly unknown[], N extends SizeType.ArgArr>(array: Ar, num: N): N extends SmallUint ? List.TakeLast<N, Ar> : N extends SizeType.ArgArrPositive ? Ar extends NonEmptyArray<unknown> ? NonEmptyArray<Ar[number]> : readonly Ar[number][] : readonly Ar[number][];
+export declare function takeLast<N extends SizeType.ArgArr>(num: N): <const Ar extends readonly unknown[]>(array: Ar) => N extends SmallUint ? List.TakeLast<N, Ar> : N extends SizeType.ArgArrPositive ? Ar extends NonEmptyArray<unknown> ? NonEmptyArray<Ar[number]> : readonly Ar[number][] : readonly Ar[number][];
+/**
+ * Skips the first N elements of an array.
+ *
+ * @example
+ *
+ * ```ts
+ * const values = ['a', 'b', 'c', 'd'] as const;
+ *
+ * const withoutFirstTwo = Arr.skip(values, 2);
+ * const withoutFirstThree = Arr.skip(3)(values);
+ *
+ * assert.deepStrictEqual(withoutFirstTwo, ['c', 'd']);
+ * assert.deepStrictEqual(withoutFirstThree, ['d']);
+ * ```
+ */
+export declare function skip<const Ar extends readonly unknown[], N extends SizeType.ArgArr>(array: Ar, num: N): N extends SmallUint ? List.Skip<N, Ar> : readonly Ar[number][];
+export declare function skip<N extends SizeType.ArgArr>(num: N): <const Ar extends readonly unknown[]>(array: Ar) => N extends SmallUint ? List.Skip<N, Ar> : readonly Ar[number][];
+/**
+ * Skips the last N elements of an array.
+ *
+ * @example
+ *
+ * ```ts
+ * const values = ['a', 'b', 'c', 'd'];
+ *
+ * const withoutLastTwo = Arr.skipLast(values, 2);
+ * const withoutLastThree = Arr.skipLast(3)(values);
+ *
+ * assert.deepStrictEqual(withoutLastTwo, ['a', 'b']);
+ * assert.deepStrictEqual(withoutLastThree, ['a']);
+ * ```
+ */
+export declare function skipLast<const Ar extends readonly unknown[], N extends SizeType.ArgArr>(array: Ar, num: N): N extends SmallUint ? List.SkipLast<N, Ar> : readonly Ar[number][];
+export declare function skipLast<N extends SizeType.ArgArr>(num: N): <const Ar extends readonly unknown[]>(array: Ar) => N extends SmallUint ? List.SkipLast<N, Ar> : readonly Ar[number][];
+/**
+ * Alias for `tail`.
+ *
+ * @see {@link tail}
+ */
+export declare const rest: <const Ar extends readonly unknown[]>(array: Ar) => List.Tail<Ar>;
+/**
+ * Alias for `skip`.
+ *
+ * @see {@link skip}
+ */
+export declare const drop: typeof skip;
+//# sourceMappingURL=array-utils-slicing.d.mts.map

package/dist/array/impl/array-utils-slicing.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array-utils-slicing.d.mts","sourceRoot":"","sources":["../../../src/array/impl/array-utils-slicing.mts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,IAAI,GAAI,KAAK,CAAC,EAAE,SAAS,SAAS,OAAO,EAAE,EACtD,OAAO,EAAE,KACR,IAAI,CAAC,IAAI,CAAC,EAAE,CAE6B,CAAC;AAE7C;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO,GAAI,KAAK,CAAC,EAAE,SAAS,SAAS,OAAO,EAAE,EACzD,OAAO,EAAE,KACR,IAAI,CAAC,OAAO,CAAC,EAAE,CAEyD,CAAC;AAE5E;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,IAAI,CAClB,KAAK,CAAC,EAAE,SAAS,SAAS,OAAO,EAAE,EACnC,CAAC,SAAS,QAAQ,CAAC,MAAM,EAEzB,KAAK,EAAE,EAAE,EACT,GAAG,EAAE,CAAC,GACL,CAAC,SAAS,SAAS,GAClB,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,GAChB,CAAC,SAAS,QAAQ,CAAC,cAAc,GAC/B,EAAE,SAAS,aAAa,CAAC,OAAO,CAAC,GAC/B,aAAa,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,GACzB,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,GACvB,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;AAE5B,wBAAgB,IAAI,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,EAC5C,GAAG,EAAE,CAAC,GACL,CAAC,KAAK,CAAC,EAAE,SAAS,SAAS,OAAO,EAAE,EACrC,KAAK,EAAE,EAAE,KACN,CAAC,SAAS,SAAS,GACpB,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,GAChB,CAAC,SAAS,QAAQ,CAAC,cAAc,GAC/B,EAAE,SAAS,aAAa,CAAC,OAAO,CAAC,GAC/B,aAAa,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,GACzB,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,GACvB,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;AAmB5B;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,QAAQ,CACtB,KAAK,CAAC,EAAE,SAAS,SAAS,OAAO,EAAE,EACnC,CAAC,SAAS,QAAQ,CAAC,MAAM,EAEzB,KAAK,EAAE,EAAE,EACT,GAAG,EAAE,CAAC,GACL,CAAC,SAAS,SAAS,GAClB,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,GACpB,CAAC,SAAS,QAAQ,CAAC,cAAc,GAC/B,EAAE,SAAS,aAAa,CAAC,OAAO,CAAC,GAC/B,aAAa,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,GACzB,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,GACvB,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;AAE5B,wBAAgB,QAAQ,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,EAChD,GAAG,EAAE,CAAC,GACL,CAAC,KAAK,CAAC,EAAE,SAAS,SAAS,OAAO,EAAE,EACrC,KAAK,EAAE,EAAE,KACN,CAAC,SAAS,SAAS,GACpB,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,GACpB,CAAC,SAAS,QAAQ,CAAC,cAAc,GAC/B,EAAE,SAAS,aAAa,CAAC,OAAO,CAAC,GAC/B,aAAa,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,GACzB,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,GACvB,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;AAmB5B;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,IAAI,CAClB,KAAK,CAAC,EAAE,SAAS,SAAS,OAAO,EAAE,EACnC,CAAC,SAAS,QAAQ,CAAC,MAAM,EAEzB,KAAK,EAAE,EAAE,EACT,GAAG,EAAE,CAAC,GACL,CAAC,SAAS,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;AAGlE,wBAAgB,IAAI,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,EAC5C,GAAG,EAAE,CAAC,GACL,CAAC,KAAK,CAAC,EAAE,SAAS,SAAS,OAAO,EAAE,EACrC,KAAK,EAAE,EAAE,KACN,CAAC,SAAS,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;AAiBpE;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,QAAQ,CACtB,KAAK,CAAC,EAAE,SAAS,SAAS,OAAO,EAAE,EACnC,CAAC,SAAS,QAAQ,CAAC,MAAM,EAEzB,KAAK,EAAE,EAAE,EACT,GAAG,EAAE,CAAC,GACL,CAAC,SAAS,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;AAGtE,wBAAgB,QAAQ,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,EAChD,GAAG,EAAE,CAAC,GACL,CAAC,KAAK,CAAC,EAAE,SAAS,SAAS,OAAO,EAAE,EACrC,KAAK,EAAE,EAAE,KACN,CAAC,SAAS,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;AAmBxE;;;;GAIG;AACH,eAAO,MAAM,IAAI,SA9OU,EAAE,SAAS,SAAS,OAAO,EAAE,SAC/C,EAAE,KACR,IAAI,CAAC,IAAI,CAAC,EAAE,CA4OS,CAAC;AAEzB;;;;GAIG;AACH,eAAO,MAAM,IAAI,aAAO,CAAC"}

package/dist/array/impl/array-utils-slicing.mjs

@@ -0,0 +1,140 @@
+import '../../number/branded-types/finite-number.mjs';
+import '../../number/branded-types/int.mjs';
+import '../../number/branded-types/int16.mjs';
+import '../../number/branded-types/int32.mjs';
+import '../../number/branded-types/non-negative-finite-number.mjs';
+import '../../number/branded-types/non-negative-int16.mjs';
+import '../../number/branded-types/non-negative-int32.mjs';
+import '../../number/branded-types/non-zero-finite-number.mjs';
+import '../../number/branded-types/non-zero-int.mjs';
+import '../../number/branded-types/non-zero-int16.mjs';
+import '../../number/branded-types/non-zero-int32.mjs';
+import '../../number/branded-types/non-zero-safe-int.mjs';
+import '../../number/branded-types/non-zero-uint16.mjs';
+import '../../number/branded-types/non-zero-uint32.mjs';
+import '../../number/branded-types/positive-finite-number.mjs';
+import '../../number/branded-types/positive-int.mjs';
+import '../../number/branded-types/positive-int16.mjs';
+import '../../number/branded-types/positive-int32.mjs';
+import '../../number/branded-types/positive-safe-int.mjs';
+import '../../number/branded-types/positive-uint16.mjs';
+import '../../number/branded-types/positive-uint32.mjs';
+import '../../number/branded-types/safe-int.mjs';
+import '../../number/branded-types/safe-uint.mjs';
+import '../../number/branded-types/uint.mjs';
+import '../../number/branded-types/uint16.mjs';
+import { Uint32 } from '../../number/branded-types/uint32.mjs';
+import '../../number/enum/int8.mjs';
+import '../../number/enum/uint8.mjs';
+import '../../number/num.mjs';
+import '../../number/refined-number-utils.mjs';
+import { size } from './array-utils-size.mjs';
+import { sliceClamped } from './array-utils-slice-clamped.mjs';
+import { isEmpty } from './array-utils-validation.mjs';
+
+/**
+ * Returns all elements of an array except the first one.
+ *
+ * @example
+ *
+ * ```ts
+ * {
+ *   const scientists = ['Ada', 'Grace', 'Katherine'] as const;
+ *   const remainder = Arr.tail(scientists);
+ *
+ *   assert.deepStrictEqual(remainder, ['Grace', 'Katherine']);
+ *   assert(remainder.length === 2);
+ * }
+ * {
+ *   const values = [1, 2, 3] as const;
+ *
+ *   const remainder = Arr.rest(values);
+ *   const emptyRemainder = Arr.rest([1] as const);
+ *
+ *   assert.deepStrictEqual(remainder, [2, 3] as const);
+ *   assert.deepStrictEqual(emptyRemainder, [] as const);
+ * }
+ * ```
+ */
+const tail = (array) => 
+// eslint-disable-next-line total-functions/no-unsafe-type-assertion
+array.slice(1);
+/**
+ * Returns all elements of an array except the last one.
+ *
+ * @example
+ *
+ * ```ts
+ * const queue = ['task-1', 'task-2', 'task-3'] as const;
+ * const withoutLast = Arr.butLast(queue);
+ *
+ * assert.deepStrictEqual(withoutLast, ['task-1', 'task-2']);
+ * assert(withoutLast.length === 2);
+ * ```
+ */
+const butLast = (array) => 
+// eslint-disable-next-line total-functions/no-unsafe-type-assertion
+(isEmpty(array) ? [] : array.slice(0, -1));
+function take(...args) {
+    switch (args.length) {
+        case 2: {
+            const [array, num] = args;
+            return sliceClamped(array, 0, num);
+        }
+        case 1: {
+            const [num] = args;
+            return (array) => take(array, num);
+        }
+    }
+}
+function takeLast(...args) {
+    switch (args.length) {
+        case 2: {
+            const [array, num] = args;
+            return sliceClamped(array, Uint32.sub(size(array), num), size(array));
+        }
+        case 1: {
+            const [num] = args;
+            return (array) => takeLast(array, num);
+        }
+    }
+}
+function skip(...args) {
+    switch (args.length) {
+        case 2: {
+            const [array, num] = args;
+            return sliceClamped(array, num, size(array));
+        }
+        case 1: {
+            const [num] = args;
+            return (array) => skip(array, num);
+        }
+    }
+}
+function skipLast(...args) {
+    switch (args.length) {
+        case 2: {
+            const [array, num] = args;
+            return sliceClamped(array, 0, Uint32.sub(size(array), num));
+        }
+        case 1: {
+            const [num] = args;
+            return (array) => skipLast(array, num);
+        }
+    }
+}
+/**
+ * Alias for `tail`.
+ *
+ * @see {@link tail}
+ */
+const rest = tail;
+/**
+ * Alias for `skip`.
+ *
+ * @see {@link skip}
+ */
+const drop = skip;
+
+export { butLast, drop, rest, skip, skipLast, tail, take, takeLast };
+//# sourceMappingURL=array-utils-slicing.mjs.map

package/dist/array/impl/array-utils-slicing.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"array-utils-slicing.mjs","sources":["../../../src/array/impl/array-utils-slicing.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA;;;;;;;;;;;;;;;;;;;;;;;AAuBG;AACI,MAAM,IAAI,GAAG,CAClB,KAAS;AAET;AACA,KAAK,CAAC,KAAK,CAAC,CAAC;AAEf;;;;;;;;;;;;AAYG;AACI,MAAM,OAAO,GAAG,CACrB,KAAS;AAET;AACA,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;AA2CrC,SAAU,IAAI,CAClB,GAAG,IAEgC,EAAA;AAEnC,IAAA,QAAQ,IAAI,CAAC,MAAM;QACjB,KAAK,CAAC,EAAE;AACN,YAAA,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,IAAI;YACzB,OAAO,YAAY,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC;QACpC;QACA,KAAK,CAAC,EAAE;AACN,YAAA,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI;YAClB,OAAO,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC;QACpC;;AAEJ;AA2CM,SAAU,QAAQ,CACtB,GAAG,IAEgC,EAAA;AAEnC,IAAA,QAAQ,IAAI,CAAC,MAAM;QACjB,KAAK,CAAC,EAAE;AACN,YAAA,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,IAAI;YACzB,OAAO,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACvE;QACA,KAAK,CAAC,EAAE;AACN,YAAA,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI;YAClB,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC;QACxC;;AAEJ;AAgCM,SAAU,IAAI,CAClB,GAAG,IAA2E,EAAA;AAE9E,IAAA,QAAQ,IAAI,CAAC,MAAM;QACjB,KAAK,CAAC,EAAE;AACN,YAAA,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,IAAI;YACzB,OAAO,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9C;QACA,KAAK,CAAC,EAAE;AACN,YAAA,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI;YAClB,OAAO,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC;QACpC;;AAEJ;AAgCM,SAAU,QAAQ,CACtB,GAAG,IAEgC,EAAA;AAEnC,IAAA,QAAQ,IAAI,CAAC,MAAM;QACjB,KAAK,CAAC,EAAE;AACN,YAAA,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,IAAI;AACzB,YAAA,OAAO,YAAY,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;QAC7D;QACA,KAAK,CAAC,EAAE;AACN,YAAA,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI;YAClB,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC;QACxC;;AAEJ;AAEA;;;;AAIG;AACI,MAAM,IAAI,GAAG;AAEpB;;;;AAIG;AACI,MAAM,IAAI,GAAG;;;;"}