ts-data-forge 6.4.0 → 6.6.0

package/src/array/impl/array-utils-iterators.test.mts

@@ -4,7 +4,7 @@ import { entries, indices, values } from './array-utils-iterators.mjs';
 
 describe(entries, () => {
   test('should return array of index-value pairs', () => {
-    const fruits = ['apple', 'banana', 'cherry'];
+    const fruits = ['apple', 'banana', 'cherry'] as const;
 
     const es = Array.from(entries(fruits));
 
@@ -31,7 +31,7 @@ describe(entries, () => {
   });
 
   test('should work with empty array', () => {
-    const empty: readonly string[] = [];
+    const empty: readonly string[] = [] as const;
 
     const es = Array.from(entries(empty));
 
@@ -56,7 +56,7 @@ describe(entries, () => {
 
 describe(values, () => {
   test('should return copy of array values', () => {
-    const numbers = [1, 2, 3];
+    const numbers = [1, 2, 3] as const;
 
     const vs = Array.from(values(numbers));
 
@@ -77,7 +77,7 @@ describe(values, () => {
   });
 
   test('should work with empty array', () => {
-    const empty: readonly number[] = [];
+    const empty: readonly number[] = [] as const;
 
     const vs = Array.from(values(empty));
 
@@ -98,7 +98,7 @@ describe(values, () => {
 
 describe(indices, () => {
   test('should return array of indices', () => {
-    const fruits = ['apple', 'banana', 'cherry'];
+    const fruits = ['apple', 'banana', 'cherry'] as const;
 
     const ks = Array.from(indices(fruits));
 
@@ -117,7 +117,7 @@ describe(indices, () => {
   });
 
   test('should work with empty array', () => {
-    const empty: readonly string[] = [];
+    const empty: readonly string[] = [] as const;
 
     const ks = Array.from(indices(empty));
 

package/src/array/impl/array-utils-modification.mts

@@ -8,7 +8,7 @@ import { copy, create } from './array-utils-creation.mjs';
  * @example
  *
  * ```ts
- * const scores: readonly number[] = [10, 20, 30];
+ * const scores: readonly number[] = [10, 20, 30] as const;
  *
  * const updated = Arr.set(scores, 1, 25);
  *
@@ -63,7 +63,7 @@ export function set<E, const V = E>(
  * @example
  *
  * ```ts
- * const temperatures: readonly number[] = [20, 21, 22];
+ * const temperatures: readonly number[] = [20, 21, 22] as const;
  *
  * const increased = Arr.toUpdated(temperatures, 1, (value) => value + 5);
  *
@@ -341,7 +341,7 @@ export function toUnshifted<Ar extends readonly unknown[], const V>(
  * @example
  *
  * ```ts
- * const base = [1, 2, 3];
+ * const base = [1, 2, 3] as const;
  *
  * const filled = Arr.toFilled(base, 0);
  *
@@ -396,7 +396,7 @@ export function toFilled<E>(
  * @example
  *
  * ```ts
- * const base = [0, 1, 2, 3, 4];
+ * const base = [0, 1, 2, 3, 4] as const;
  *
  * const filledMiddle = Arr.toRangeFilled(base, 9, [1, 4]);
  *

package/src/array/impl/array-utils-modification.test.mts

@@ -104,7 +104,7 @@ describe('Arr modifications', () => {
     });
 
     test('case 4 (number[])', () => {
-      const xs: readonly number[] = [1, 2, 3];
+      const xs: readonly number[] = [1, 2, 3] as const;
 
       const result = toRemoved(xs, 5);
 
@@ -134,7 +134,7 @@ describe('Arr modifications', () => {
     });
 
     test('case 2', () => {
-      const xs: readonly number[] = [1, 2, 3];
+      const xs: readonly number[] = [1, 2, 3] as const;
 
       const result = toPushed(xs, 4 as const);
 
@@ -164,7 +164,7 @@ describe('Arr modifications', () => {
     });
 
     test('case 2', () => {
-      const xs: readonly number[] = [1, 2, 3];
+      const xs: readonly number[] = [1, 2, 3] as const;
 
       const result = toUnshifted(xs, 4 as const);
 
@@ -184,7 +184,7 @@ describe('Arr modifications', () => {
 
   describe(toFilled, () => {
     test('should fill entire array with value', () => {
-      const arr = [1, 2, 3, 4, 5];
+      const arr = [1, 2, 3, 4, 5] as const;
 
       const result = toFilled(arr, 0);
 
@@ -194,7 +194,7 @@ describe('Arr modifications', () => {
     test('should work with curried version', () => {
       const fillWithZero = toFilled(0);
 
-      const arr = [1, 2, 3];
+      const arr = [1, 2, 3] as const;
 
       const result = fillWithZero(arr);
 
@@ -204,7 +204,7 @@ describe('Arr modifications', () => {
 
   describe(toRangeFilled, () => {
     test('should fill array with range', () => {
-      const arr = [1, 2, 3, 4, 5];
+      const arr = [1, 2, 3, 4, 5] as const;
 
       const result = toRangeFilled(arr, 0, [1, 4]);
 
@@ -212,7 +212,7 @@ describe('Arr modifications', () => {
     });
 
     test('should fill with range starting from 0', () => {
-      const arr = [1, 2, 3, 4, 5];
+      const arr = [1, 2, 3, 4, 5] as const;
 
       const result = toRangeFilled(arr, 9, [0, 3]);
 
@@ -220,7 +220,7 @@ describe('Arr modifications', () => {
     });
 
     test('should handle empty range', () => {
-      const arr = [1, 2, 3];
+      const arr = [1, 2, 3] as const;
 
       const result = toRangeFilled(arr, 0, [2, 2]);
 
@@ -228,7 +228,7 @@ describe('Arr modifications', () => {
     });
 
     test('should clamp range to array bounds', () => {
-      const arr = [1, 2, 3];
+      const arr = [1, 2, 3] as readonly number[];
 
       const result = toRangeFilled(arr, 0, [1, 10]);
 
@@ -236,7 +236,7 @@ describe('Arr modifications', () => {
     });
 
     test('should handle negative start (clamped to 0)', () => {
-      const arr = [1, 2, 3];
+      const arr = [1, 2, 3] as readonly number[];
 
       const result = toRangeFilled(arr, 9, [-5, 2]);
 
@@ -252,14 +252,14 @@ describe('Arr modifications', () => {
     });
 
     test('A non-integer starting value should result in a type error', () => {
-      const arr = [1, 2, 3];
+      const arr = [1, 2, 3] as const;
 
       // @ts-expect-error start must be an integer
       assert.deepStrictEqual(toRangeFilled(arr, 0, [1.5, 3]), [1, 0, 0]);
     });
 
     test('A non-integer ending value should result in a type error', () => {
-      const arr = [1, 2, 3];
+      const arr = [1, 2, 3] as const;
 
       // @ts-expect-error end must be an integer
       assert.deepStrictEqual(toRangeFilled(arr, 0, [1, 2.5]), [1, 0, 3]);

package/src/array/impl/array-utils-overload-type-error.test.mts

@@ -148,7 +148,7 @@ describe('Array overloaded functions - type error validation', () => {
       const invalidArgs: readonly [readonly string[], (x: string) => number] = [
         ['a'],
         (x) => x.length,
-      ];
+      ] as const;
 
       // @ts-expect-error - Wrong types in tuple for spread
       findIndex(...invalidArgs);

package/src/array/impl/array-utils-reducing-value.mts

@@ -14,7 +14,7 @@ import { isNonEmpty } from './array-utils-validation.mjs';
  * ```ts
  * const values = [5, 3, 9] as const;
  *
- * const empty: readonly number[] = [];
+ * const empty: readonly number[] = [] as const;
  *
  * const smallest = Arr.min(values);
  *
@@ -64,7 +64,7 @@ export function min<E extends number>(
  * @example
  *
  * ```ts
- * const values = [5, 3, 9];
+ * const values = [5, 3, 9] as const;
  *
  * const largest = Arr.max(values);
  *
@@ -155,7 +155,7 @@ export function minBy<E, V>(
  *   { id: 'a', stars: 10 },
  *   { id: 'b', stars: 30 },
  *   { id: 'c', stars: 20 },
- * ];
+ * ] as const;
  *
  * const mostStars = Arr.maxBy(projects, (project) => project.stars);
  *
@@ -318,7 +318,7 @@ export function countBy<E, G extends MapSetKeyType>(
  * @example
  *
  * ```ts
- * const words = ['Ada', 'Lovelace'];
+ * const words = ['Ada', 'Lovelace'] as const;
  *
  * const totalLength = Arr.foldl(words, (acc, word) => acc + word.length, 0);
  *
@@ -395,7 +395,7 @@ export function foldl<E, P>(
  * @example
  *
  * ```ts
- * const numbers = [1, 2, 3];
+ * const numbers = [1, 2, 3] as const;
  *
  * const subtractRight = Arr.foldr(numbers, (acc, value) => acc - value, 0);
  *
@@ -496,6 +496,7 @@ export function sum(array: readonly Int[]): Int;
 export function sum(array: readonly number[]): number;
 
 export function sum(array: readonly number[]): number {
+  // eslint-disable-next-line ts-data-forge/prefer-arr-sum
   return array.reduce((prev, curr) => prev + curr, 0);
 }
 

package/src/array/impl/array-utils-reducing-value.test.mts

@@ -93,7 +93,7 @@ describe('Arr reducing value', () => {
     });
 
     test('case 3: readonly array', () => {
-      const arr: readonly number[] = [1, 5, 2];
+      const arr: readonly number[] = [1, 5, 2] as const;
 
       const res = max(arr);
 
@@ -107,7 +107,7 @@ describe('Arr reducing value', () => {
     });
 
     test('case 4: empty array', () => {
-      const arr: readonly number[] = [];
+      const arr: readonly number[] = [] as const;
 
       const res = max(arr);
 
@@ -152,7 +152,7 @@ describe('Arr reducing value', () => {
     });
 
     test('case 2: empty array', () => {
-      const arr: readonly Readonly<{ x: number }>[] = [];
+      const arr: readonly Readonly<{ x: number }>[] = [] as const;
 
       const res = minBy(arr, (a) => a.x);
 
@@ -228,7 +228,7 @@ describe('Arr reducing value', () => {
     });
 
     test('case 2: empty array', () => {
-      const arr: readonly Readonly<{ x: number }>[] = [];
+      const arr: readonly Readonly<{ x: number }>[] = [] as const;
 
       const res = maxBy(arr, (a) => a.x);
 
@@ -288,7 +288,7 @@ describe('Arr reducing value', () => {
     });
 
     test('case 2: empty array', () => {
-      const arr: readonly number[] = [];
+      const arr: readonly number[] = [] as const;
 
       const res = count(arr, (x) => x > 0);
 
@@ -332,7 +332,7 @@ describe('Arr reducing value', () => {
     });
 
     test('case 2: empty array', () => {
-      const arr: readonly Readonly<{ x: number }>[] = [];
+      const arr: readonly Readonly<{ x: number }>[] = [] as const;
 
       const res = countBy(arr, (a) => a.x);
 
@@ -485,7 +485,7 @@ describe('Arr reducing value', () => {
 
   describe(join, () => {
     test('should join array elements', () => {
-      const arr = ['Hello', 'World'];
+      const arr = ['Hello', 'World'] as const;
 
       const result = join(arr, ' ');
 
@@ -495,7 +495,7 @@ describe('Arr reducing value', () => {
     });
 
     test('should handle empty separator', () => {
-      const arr = ['a', 'b', 'c'];
+      const arr = ['a', 'b', 'c'] as const;
 
       const result = join(arr, '');
 
@@ -505,7 +505,7 @@ describe('Arr reducing value', () => {
     });
 
     test('should handle undefined separator', () => {
-      const arr = ['a', 'b', 'c'];
+      const arr = ['a', 'b', 'c'] as const;
 
       const result = join(arr);
 

package/src/array/impl/array-utils-search.mts

@@ -11,7 +11,7 @@ import { asUint32 } from '../../number/index.mjs';
  * const users = [
  *   { id: 1, name: 'Ada' },
  *   { id: 2, name: 'Grace' },
- * ];
+ * ] as const;
  *
  * const found = Arr.find(users, (user) => user.id === 2);
  *
@@ -100,7 +100,7 @@ export function find<E>(
  * @example
  *
  * ```ts
- * const numbers = [1, 3, 2, 4, 5];
+ * const numbers = [1, 3, 2, 4, 5] as const;
  *
  * const lastEven = Arr.findLast(numbers, (n) => n % 2 === 0);
  *
@@ -187,7 +187,7 @@ export function findLast<E>(
  * @example
  *
  * ```ts
- * const letters = ['a', 'b', 'c'];
+ * const letters = ['a', 'b', 'c'] as const;
  *
  * const indexOfB = Arr.findIndex(letters, (letter) => letter === 'b');
  *
@@ -254,7 +254,7 @@ export function findIndex<E>(
  * @example
  *
  * ```ts
- * const letters = ['a', 'b', 'c', 'b'];
+ * const letters = ['a', 'b', 'c', 'b'] as const;
  *
  * const lastIndexOfB = Arr.findLastIndex(letters, (letter) => letter === 'b');
  *
@@ -321,7 +321,7 @@ export function findLastIndex<E>(
  * @example
  *
  * ```ts
- * const fruits = ['apple', 'banana', 'orange', 'banana'];
+ * const fruits = ['apple', 'banana', 'orange', 'banana'] as readonly string[];
  *
  * const indexOfBanana = Arr.indexOf(fruits, 'banana');
  *
@@ -376,7 +376,7 @@ export function indexOf<E>(
  * @example
  *
  * ```ts
- * const fruits = ['apple', 'banana', 'orange', 'banana'];
+ * const fruits = ['apple', 'banana', 'orange', 'banana'] as readonly string[];
  *
  * // Search for 'banana' starting from index 1
  * const firstBanana = Arr.indexOfFrom(fruits, 'banana', 1);
@@ -444,7 +444,7 @@ export function indexOfFrom<E>(
  * @example
  *
  * ```ts
- * const fruits = ['apple', 'banana', 'orange', 'banana'];
+ * const fruits = ['apple', 'banana', 'orange', 'banana'] as readonly string[];
  *
  * const lastBanana = Arr.lastIndexOf(fruits, 'banana');
  *
@@ -503,7 +503,7 @@ export function lastIndexOf<E>(
  * @example
  *
  * ```ts
- * const fruits = ['apple', 'banana', 'orange', 'banana', 'grape'];
+ * const fruits = ['apple', 'banana', 'orange', 'banana', 'grape'] as const;
  *
  * // Search backwards for 'banana' from index 3
  * const lastBananaFrom3 = Arr.lastIndexOfFrom(fruits, 'banana', 3);