complete-common 1.4.0 → 2.0.0

package/dist/functions/array.d.cts

@@ -8,7 +8,7 @@ import type { WidenLiteral } from "../index.js";
  * Helper function to copy a two-dimensional array. Note that the sub-arrays will only be shallow
  * copied (using the spread operator).
  */
-export declare function arrayCopyTwoDimensional<T>(array: ReadonlyArray<readonly T[]>): T[][];
+export declare function arrayCopyTwoDimensional<T>(array: ReadonlyArray<readonly T[]>): readonly T[][];
 /**
  * Helper function for determining if two arrays contain the exact same elements. Note that this
  * only performs a shallow comparison.
@@ -21,7 +21,7 @@ export declare function arrayEquals<T>(array1: readonly T[], array2: readonly T[
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
-export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsToRemove: readonly T[]): T[];
+export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsToRemove: readonly T[]): readonly T[];
 /**
  * Removes the specified element(s) from the array. If the specified element(s) are not found in the
  * array, this function will do nothing.
@@ -34,7 +34,7 @@ export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsT
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
-export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: readonly T[]): T[];
+export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: readonly T[]): readonly T[];
 /** Helper function to remove all of the elements in an array in-place. */
 export declare function emptyArray(array: unknown[]): void;
 /**
@@ -48,7 +48,7 @@ export declare function emptyArray(array: unknown[]): void;
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html
  */
-export declare function filterMap<OldT, NewT>(array: readonly OldT[], func: (element: OldT) => NewT | undefined): NewT[];
+export declare function filterMap<OldT, NewT>(array: readonly OldT[], func: (element: OldT) => NewT | undefined): readonly NewT[];
 /**
  * Helper function to get a random element from the provided array.
  *
@@ -77,7 +77,7 @@ export declare function includes<T, TupleElement extends WidenLiteral<T>>(array:
 /** A wrapper around `Array.isArray` that narrows to `unknown[]` instead of `any[]`. */
 export declare function isArray(arg: unknown): arg is unknown[];
 /** Initializes an array with all elements containing the specified default value. */
-export declare function newArray<T>(length: number, value: T): T[];
+export declare function newArray<T>(length: number, value: T): readonly T[];
 /** Helper function to sum every value in an array together. */
 export declare function sumArray(array: readonly number[]): number;
 //# sourceMappingURL=array.d.ts.map

package/dist/functions/array.d.mts

@@ -8,7 +8,7 @@ import type { WidenLiteral } from "../index.js";
  * Helper function to copy a two-dimensional array. Note that the sub-arrays will only be shallow
  * copied (using the spread operator).
  */
-export declare function arrayCopyTwoDimensional<T>(array: ReadonlyArray<readonly T[]>): T[][];
+export declare function arrayCopyTwoDimensional<T>(array: ReadonlyArray<readonly T[]>): readonly T[][];
 /**
  * Helper function for determining if two arrays contain the exact same elements. Note that this
  * only performs a shallow comparison.
@@ -21,7 +21,7 @@ export declare function arrayEquals<T>(array1: readonly T[], array2: readonly T[
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
-export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsToRemove: readonly T[]): T[];
+export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsToRemove: readonly T[]): readonly T[];
 /**
  * Removes the specified element(s) from the array. If the specified element(s) are not found in the
  * array, this function will do nothing.
@@ -34,7 +34,7 @@ export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsT
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
-export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: readonly T[]): T[];
+export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: readonly T[]): readonly T[];
 /** Helper function to remove all of the elements in an array in-place. */
 export declare function emptyArray(array: unknown[]): void;
 /**
@@ -48,7 +48,7 @@ export declare function emptyArray(array: unknown[]): void;
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html
  */
-export declare function filterMap<OldT, NewT>(array: readonly OldT[], func: (element: OldT) => NewT | undefined): NewT[];
+export declare function filterMap<OldT, NewT>(array: readonly OldT[], func: (element: OldT) => NewT | undefined): readonly NewT[];
 /**
  * Helper function to get a random element from the provided array.
  *
@@ -77,7 +77,7 @@ export declare function includes<T, TupleElement extends WidenLiteral<T>>(array:
 /** A wrapper around `Array.isArray` that narrows to `unknown[]` instead of `any[]`. */
 export declare function isArray(arg: unknown): arg is unknown[];
 /** Initializes an array with all elements containing the specified default value. */
-export declare function newArray<T>(length: number, value: T): T[];
+export declare function newArray<T>(length: number, value: T): readonly T[];
 /** Helper function to sum every value in an array together. */
 export declare function sumArray(array: readonly number[]): number;
 //# sourceMappingURL=array.d.ts.map

package/dist/functions/array.d.ts

@@ -8,7 +8,7 @@ import type { WidenLiteral } from "../index.js";
  * Helper function to copy a two-dimensional array. Note that the sub-arrays will only be shallow
  * copied (using the spread operator).
  */
-export declare function arrayCopyTwoDimensional<T>(array: ReadonlyArray<readonly T[]>): T[][];
+export declare function arrayCopyTwoDimensional<T>(array: ReadonlyArray<readonly T[]>): readonly T[][];
 /**
  * Helper function for determining if two arrays contain the exact same elements. Note that this
  * only performs a shallow comparison.
@@ -21,7 +21,7 @@ export declare function arrayEquals<T>(array1: readonly T[], array2: readonly T[
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
-export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsToRemove: readonly T[]): T[];
+export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsToRemove: readonly T[]): readonly T[];
 /**
  * Removes the specified element(s) from the array. If the specified element(s) are not found in the
  * array, this function will do nothing.
@@ -34,7 +34,7 @@ export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsT
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
-export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: readonly T[]): T[];
+export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: readonly T[]): readonly T[];
 /** Helper function to remove all of the elements in an array in-place. */
 export declare function emptyArray(array: unknown[]): void;
 /**
@@ -48,7 +48,7 @@ export declare function emptyArray(array: unknown[]): void;
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html
  */
-export declare function filterMap<OldT, NewT>(array: readonly OldT[], func: (element: OldT) => NewT | undefined): NewT[];
+export declare function filterMap<OldT, NewT>(array: readonly OldT[], func: (element: OldT) => NewT | undefined): readonly NewT[];
 /**
  * Helper function to get a random element from the provided array.
  *
@@ -77,7 +77,7 @@ export declare function includes<T, TupleElement extends WidenLiteral<T>>(array:
 /** A wrapper around `Array.isArray` that narrows to `unknown[]` instead of `any[]`. */
 export declare function isArray(arg: unknown): arg is unknown[];
 /** Initializes an array with all elements containing the specified default value. */
-export declare function newArray<T>(length: number, value: T): T[];
+export declare function newArray<T>(length: number, value: T): readonly T[];
 /** Helper function to sum every value in an array together. */
 export declare function sumArray(array: readonly number[]): number;
 //# sourceMappingURL=array.d.ts.map

package/dist/functions/array.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../src/functions/array.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAKhD;;;GAGG;AAEH,wBAAgB,uBAAuB,CAAC,CAAC,EACvC,KAAK,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,GACjC,CAAC,EAAE,EAAE,CAQP;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,MAAM,EAAE,SAAS,CAAC,EAAE,EACpB,MAAM,EAAE,SAAS,CAAC,EAAE,GACnB,OAAO,CAST;AAED;;;;;;GAMG;AAEH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,aAAa,EAAE,SAAS,CAAC,EAAE,EAC3B,GAAG,gBAAgB,EAAE,SAAS,CAAC,EAAE,GAChC,CAAC,EAAE,CAWL;AAED;;;;;;;;;;;GAWG;AAEH,wBAAgB,kBAAkB,CAAC,CAAC,EAElC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,gBAAgB,EAAE,SAAS,CAAC,EAAE,GAChC,CAAC,EAAE,CAYL;AAED,0EAA0E;AAE1E,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAEjD;AAED;;;;;;;;;;GAUG;AAEH,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAClC,KAAK,EAAE,SAAS,IAAI,EAAE,EACtB,IAAI,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,IAAI,GAAG,SAAS,GACxC,IAAI,EAAE,CAWR;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,KAAK,EAAE,SAAS,CAAC,EAAE,EACnB,UAAU,GAAE,SAAS,CAAC,EAAO,GAC5B,CAAC,CAiBH;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,SAAS,OAAO,EAAE,EACzB,UAAU,GAAE,SAAS,MAAM,EAAO,GACjC,MAAM,CAQR;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,YAAY,SAAS,YAAY,CAAC,CAAC,CAAC,EAC9D,KAAK,EAAE,SAAS,YAAY,EAAE,EAC9B,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC,GAC7B,aAAa,IAAI,YAAY,CAG/B;AAED,uFAAuF;AACvF,wBAAgB,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,OAAO,EAAE,CAEtD;AAED,qFAAqF;AAErF,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,CAEzD;AAED,+DAA+D;AAC/D,wBAAgB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAEzD"}
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../src/functions/array.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAKhD;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EACvC,KAAK,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,GACjC,SAAS,CAAC,EAAE,EAAE,CAQhB;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,MAAM,EAAE,SAAS,CAAC,EAAE,EACpB,MAAM,EAAE,SAAS,CAAC,EAAE,GACnB,OAAO,CAST;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,aAAa,EAAE,SAAS,CAAC,EAAE,EAC3B,GAAG,gBAAgB,EAAE,SAAS,CAAC,EAAE,GAChC,SAAS,CAAC,EAAE,CAWd;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAElC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,gBAAgB,EAAE,SAAS,CAAC,EAAE,GAChC,SAAS,CAAC,EAAE,CAYd;AAED,0EAA0E;AAE1E,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAEjD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAClC,KAAK,EAAE,SAAS,IAAI,EAAE,EACtB,IAAI,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,IAAI,GAAG,SAAS,GACxC,SAAS,IAAI,EAAE,CAWjB;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,KAAK,EAAE,SAAS,CAAC,EAAE,EACnB,UAAU,GAAE,SAAS,CAAC,EAAO,GAC5B,CAAC,CAiBH;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,SAAS,OAAO,EAAE,EACzB,UAAU,GAAE,SAAS,MAAM,EAAO,GACjC,MAAM,CAQR;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,YAAY,SAAS,YAAY,CAAC,CAAC,CAAC,EAC9D,KAAK,EAAE,SAAS,YAAY,EAAE,EAC9B,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC,GAC7B,aAAa,IAAI,YAAY,CAG/B;AAED,uFAAuF;AACvF,wBAAgB,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,OAAO,EAAE,CAEtD;AAED,qFAAqF;AACrF,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAElE;AAED,+DAA+D;AAC/D,wBAAgB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAEzD"}

package/dist/functions/assert.d.cts

@@ -3,7 +3,7 @@
  *
  * @module
  */
-import type { TranspiledEnum } from "./enums.js";
+import type { TranspiledEnum } from "../types/TranspiledEnum.js";
 /** Helper function to throw an error if the provided value is not an array. */
 export declare function assertArray(value: unknown, msg: string): asserts value is unknown[];
 /** Helper function to throw an error if the provided value is not a boolean. */

package/dist/functions/assert.d.mts

@@ -3,7 +3,7 @@
  *
  * @module
  */
-import type { TranspiledEnum } from "./enums.js";
+import type { TranspiledEnum } from "../types/TranspiledEnum.js";
 /** Helper function to throw an error if the provided value is not an array. */
 export declare function assertArray(value: unknown, msg: string): asserts value is unknown[];
 /** Helper function to throw an error if the provided value is not a boolean. */

package/dist/functions/assert.d.ts

@@ -3,7 +3,7 @@
  *
  * @module
  */
-import type { TranspiledEnum } from "./enums.js";
+import type { TranspiledEnum } from "../types/TranspiledEnum.js";
 /** Helper function to throw an error if the provided value is not an array. */
 export declare function assertArray(value: unknown, msg: string): asserts value is unknown[];
 /** Helper function to throw an error if the provided value is not a boolean. */

package/dist/functions/assert.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../src/functions/assert.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAIjD,+EAA+E;AAC/E,wBAAgB,WAAW,CACzB,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,OAAO,EAAE,CAI5B;AAED,gFAAgF;AAChF,wBAAgB,aAAa,CAC3B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,OAAO,CAI1B;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,KAAK,EAAE,CAAC,EACR,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,GAC7B,CAAC,MAAM,CAAC,GACR;IACE,iFAAiF;CAClF,GACJ,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,CAIxC;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,cAAc,EACtD,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,cAAc,EAAE,CAAC,EACjB,GAAG,EAAE,MAAM,EACX,GAAG,CAAC,EAAE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC,GACjC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAI7B;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,KAAK,EAAE,CAAC,EACR,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GACxB,CAAC,MAAM,CAAC,GACR;IACE,4EAA4E;CAC7E,GACJ,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAInC;AAED,+EAA+E;AAC/E,wBAAgB,YAAY,CAC1B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,MAAM,CAIzB;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAI1C;AAED,+EAA+E;AAC/E,wBAAgB,YAAY,CAC1B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,MAAM,CAIzB"}
+{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../src/functions/assert.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAIjE,+EAA+E;AAC/E,wBAAgB,WAAW,CACzB,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,OAAO,EAAE,CAI5B;AAED,gFAAgF;AAChF,wBAAgB,aAAa,CAC3B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,OAAO,CAI1B;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,KAAK,EAAE,CAAC,EACR,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,GAC7B,CAAC,MAAM,CAAC,GACR;IACE,iFAAiF;CAClF,GACJ,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,CAIxC;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,cAAc,EACtD,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,cAAc,EAAE,CAAC,EACjB,GAAG,EAAE,MAAM,EACX,GAAG,CAAC,EAAE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC,GACjC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAI7B;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,KAAK,EAAE,CAAC,EACR,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GACxB,CAAC,MAAM,CAAC,GACR;IACE,4EAA4E;CAC7E,GACJ,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAInC;AAED,+EAA+E;AAC/E,wBAAgB,YAAY,CAC1B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,MAAM,CAIzB;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAI1C;AAED,+EAA+E;AAC/E,wBAAgB,YAAY,CAC1B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,MAAM,CAIzB"}

package/dist/functions/enums.d.cts

@@ -3,7 +3,7 @@
  *
  * @module
  */
-export type TranspiledEnum = Record<string, string | number>;
+import type { TranspiledEnum } from "../types/TranspiledEnum.js";
 /**
  * Helper function to get the entries of an enum.
  *

package/dist/functions/enums.d.mts

@@ -3,7 +3,7 @@
  *
  * @module
  */
-export type TranspiledEnum = Record<string, string | number>;
+import type { TranspiledEnum } from "../types/TranspiledEnum.js";
 /**
  * Helper function to get the entries of an enum.
  *

package/dist/functions/enums.d.ts

@@ -3,7 +3,7 @@
  *
  * @module
  */
-export type TranspiledEnum = Record<string, string | number>;
+import type { TranspiledEnum } from "../types/TranspiledEnum.js";
 /**
  * Helper function to get the entries of an enum.
  *

package/dist/functions/enums.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/functions/enums.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;AAE7D;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,cAAc,EACrD,cAAc,EAAE,CAAC,GAChB,aAAa,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CASjD;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,cAAc,EAAE,cAAc,GAAG,SAAS,MAAM,EAAE,CAG7E;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,cAAc,EACpD,cAAc,EAAE,CAAC,GAChB,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAG3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,sBAAsB,CAEpC,CAAC,SAAS,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAC/B,IAAI,SAAS,MAAM,GAAG,MAAM,KACzB,IAAI,CAAG;AAEZ;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,cAAc,EAClD,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,cAAc,EAAE,CAAC,EACjB,GAAG,CAAC,EAAE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC,GACjC,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAOrB"}
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/functions/enums.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAEjE;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,cAAc,EACrD,cAAc,EAAE,CAAC,GAChB,aAAa,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CASjD;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,cAAc,EAAE,cAAc,GAAG,SAAS,MAAM,EAAE,CAG7E;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,cAAc,EACpD,cAAc,EAAE,CAAC,GAChB,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAG3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,sBAAsB,CAEpC,CAAC,SAAS,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAC/B,IAAI,SAAS,MAAM,GAAG,MAAM,KACzB,IAAI,CAAG;AAEZ;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,cAAc,EAClD,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,cAAc,EAAE,CAAC,EACjB,GAAG,CAAC,EAAE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC,GACjC,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAOrB"}

package/dist/functions/map.d.cts

@@ -13,12 +13,16 @@
  * If you want to perform a filter and a map at the same time on an array, use the `filterMap`
  * helper function instead.
  */
-export declare function mapFilter<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): V[];
+export declare function mapFilter<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): readonly V[];
 /**
  * Helper function to find a value in a `Map`. Similar to the `Array.find` method, but works for
  * maps.
  *
  * This is efficient such that it avoids converting the map values into an array.
+ *
+ * @param map The map to search through.
+ * @param predicate Function that tests each value for a condition.
+ * @returns The first value that satisfies the predicate, or undefined if no values satisfy.
  */
-export declare function mapFind<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): V | undefined;
+export declare function mapFind<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V, key: K, map: ReadonlyMap<K, V>) => boolean): V | undefined;
 //# sourceMappingURL=map.d.ts.map

package/dist/functions/map.d.mts

@@ -13,12 +13,16 @@
  * If you want to perform a filter and a map at the same time on an array, use the `filterMap`
  * helper function instead.
  */
-export declare function mapFilter<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): V[];
+export declare function mapFilter<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): readonly V[];
 /**
  * Helper function to find a value in a `Map`. Similar to the `Array.find` method, but works for
  * maps.
  *
  * This is efficient such that it avoids converting the map values into an array.
+ *
+ * @param map The map to search through.
+ * @param predicate Function that tests each value for a condition.
+ * @returns The first value that satisfies the predicate, or undefined if no values satisfy.
  */
-export declare function mapFind<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): V | undefined;
+export declare function mapFind<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V, key: K, map: ReadonlyMap<K, V>) => boolean): V | undefined;
 //# sourceMappingURL=map.d.ts.map

package/dist/functions/map.d.ts

@@ -13,12 +13,16 @@
  * If you want to perform a filter and a map at the same time on an array, use the `filterMap`
  * helper function instead.
  */
-export declare function mapFilter<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): V[];
+export declare function mapFilter<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): readonly V[];
 /**
  * Helper function to find a value in a `Map`. Similar to the `Array.find` method, but works for
  * maps.
  *
  * This is efficient such that it avoids converting the map values into an array.
+ *
+ * @param map The map to search through.
+ * @param predicate Function that tests each value for a condition.
+ * @returns The first value that satisfies the predicate, or undefined if no values satisfy.
  */
-export declare function mapFind<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): V | undefined;
+export declare function mapFind<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V, key: K, map: ReadonlyMap<K, V>) => boolean): V | undefined;
 //# sourceMappingURL=map.d.ts.map

package/dist/functions/map.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/functions/map.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;;GAQG;AAEH,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,EAC5B,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACtB,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAC/B,CAAC,EAAE,CAWL;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAC1B,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACtB,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAC/B,CAAC,GAAG,SAAS,CASf"}
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/functions/map.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,EAC5B,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACtB,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAC/B,SAAS,CAAC,EAAE,CAWd;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAC1B,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACtB,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,OAAO,GAC/D,CAAC,GAAG,SAAS,CASf"}

package/dist/functions/object.d.cts

@@ -10,7 +10,7 @@ import type { ReadonlyRecord } from "../types/ReadonlyRecord.js";
  *
  * This is efficient such that it avoids converting the object values into an array.
  */
-export declare function objectFilter<K extends string | number | symbol, V>(object: ReadonlyRecord<K, V>, predicate: (value: V) => boolean): V[];
+export declare function objectFilter<K extends string | number | symbol, V>(object: ReadonlyRecord<K, V>, predicate: (value: V) => boolean): readonly V[];
 /**
  * Helper function to convert an object to a map.
  *
@@ -21,40 +21,13 @@ export declare function objectFilter<K extends string | number | symbol, V>(obje
  *
  * Note that the converted map will only have string keys, due to the nature of JavaScript objects
  * only having string keys under the hood.
- *
- * Also see the `objectToReadonlyMap` function.
  */
-export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): Map<K, V>;
-/**
- * Helper function to convert an object to a read-only map.
- *
- * This is useful when you need to construct a type safe object with the `satisfies` operator, but
- * then later on you need to query it in a way where you expect the return value to be T or
- * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
- * assertions.
- *
- * Note that the converted map will only have string keys, due to the nature of JavaScript objects
- * only having string keys under the hood.
- *
- * Also see the `objectToMap` function.
- */
-export declare function objectToReadonlyMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
+export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
 /**
  * Helper function to convert an object to a reverse map.
  *
  * Note that the converted map will only have string keys, due to the nature of JavaScript objects
  * only having string keys under the hood.
- *
- * Also see the `objectToReverseReadonlyMap` function.
- */
-export declare function objectToReverseMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): Map<V, K>;
-/**
- * Helper function to convert an object to a reverse read-only map.
- *
- * Note that the converted map will only have string keys, due to the nature of JavaScript objects
- * only having string keys under the hood.
- *
- * Also see the `objectToReverseMap` function.
  */
-export declare function objectToReverseReadonlyMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): ReadonlyMap<V, K>;
+export declare function objectToReverseMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): ReadonlyMap<V, K>;
 //# sourceMappingURL=object.d.ts.map

package/dist/functions/object.d.mts

@@ -10,7 +10,7 @@ import type { ReadonlyRecord } from "../types/ReadonlyRecord.js";
  *
  * This is efficient such that it avoids converting the object values into an array.
  */
-export declare function objectFilter<K extends string | number | symbol, V>(object: ReadonlyRecord<K, V>, predicate: (value: V) => boolean): V[];
+export declare function objectFilter<K extends string | number | symbol, V>(object: ReadonlyRecord<K, V>, predicate: (value: V) => boolean): readonly V[];
 /**
  * Helper function to convert an object to a map.
  *
@@ -21,40 +21,13 @@ export declare function objectFilter<K extends string | number | symbol, V>(obje
  *
  * Note that the converted map will only have string keys, due to the nature of JavaScript objects
  * only having string keys under the hood.
- *
- * Also see the `objectToReadonlyMap` function.
  */
-export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): Map<K, V>;
-/**
- * Helper function to convert an object to a read-only map.
- *
- * This is useful when you need to construct a type safe object with the `satisfies` operator, but
- * then later on you need to query it in a way where you expect the return value to be T or
- * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
- * assertions.
- *
- * Note that the converted map will only have string keys, due to the nature of JavaScript objects
- * only having string keys under the hood.
- *
- * Also see the `objectToMap` function.
- */
-export declare function objectToReadonlyMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
+export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
 /**
  * Helper function to convert an object to a reverse map.
  *
  * Note that the converted map will only have string keys, due to the nature of JavaScript objects
  * only having string keys under the hood.
- *
- * Also see the `objectToReverseReadonlyMap` function.
- */
-export declare function objectToReverseMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): Map<V, K>;
-/**
- * Helper function to convert an object to a reverse read-only map.
- *
- * Note that the converted map will only have string keys, due to the nature of JavaScript objects
- * only having string keys under the hood.
- *
- * Also see the `objectToReverseMap` function.
  */
-export declare function objectToReverseReadonlyMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): ReadonlyMap<V, K>;
+export declare function objectToReverseMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): ReadonlyMap<V, K>;
 //# sourceMappingURL=object.d.ts.map

package/dist/functions/object.d.ts

@@ -10,7 +10,7 @@ import type { ReadonlyRecord } from "../types/ReadonlyRecord.js";
  *
  * This is efficient such that it avoids converting the object values into an array.
  */
-export declare function objectFilter<K extends string | number | symbol, V>(object: ReadonlyRecord<K, V>, predicate: (value: V) => boolean): V[];
+export declare function objectFilter<K extends string | number | symbol, V>(object: ReadonlyRecord<K, V>, predicate: (value: V) => boolean): readonly V[];
 /**
  * Helper function to convert an object to a map.
  *
@@ -21,40 +21,13 @@ export declare function objectFilter<K extends string | number | symbol, V>(obje
  *
  * Note that the converted map will only have string keys, due to the nature of JavaScript objects
  * only having string keys under the hood.
- *
- * Also see the `objectToReadonlyMap` function.
  */
-export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): Map<K, V>;
-/**
- * Helper function to convert an object to a read-only map.
- *
- * This is useful when you need to construct a type safe object with the `satisfies` operator, but
- * then later on you need to query it in a way where you expect the return value to be T or
- * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
- * assertions.
- *
- * Note that the converted map will only have string keys, due to the nature of JavaScript objects
- * only having string keys under the hood.
- *
- * Also see the `objectToMap` function.
- */
-export declare function objectToReadonlyMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
+export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
 /**
  * Helper function to convert an object to a reverse map.
  *
  * Note that the converted map will only have string keys, due to the nature of JavaScript objects
  * only having string keys under the hood.
- *
- * Also see the `objectToReverseReadonlyMap` function.
- */
-export declare function objectToReverseMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): Map<V, K>;
-/**
- * Helper function to convert an object to a reverse read-only map.
- *
- * Note that the converted map will only have string keys, due to the nature of JavaScript objects
- * only having string keys under the hood.
- *
- * Also see the `objectToReverseMap` function.
  */
-export declare function objectToReverseReadonlyMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): ReadonlyMap<V, K>;
+export declare function objectToReverseMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): ReadonlyMap<V, K>;
 //# sourceMappingURL=object.d.ts.map

package/dist/functions/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/functions/object.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAEjE;;;;;GAKG;AAEH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EAChE,MAAM,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5B,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAC/B,CAAC,EAAE,CAaL;AAED;;;;;;;;;;;;GAYG;AAEH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EAC/D,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAQX;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EACvE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAEnB;AAED;;;;;;;GAOG;AAEH,wBAAgB,kBAAkB,CAChC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAClC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAClC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAQjC;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAClC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAClC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAEzC"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/functions/object.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAEjE;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EAChE,MAAM,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5B,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAC/B,SAAS,CAAC,EAAE,CAad;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EAC/D,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAQnB;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAClC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAClC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAQzC"}

package/dist/functions/set.d.cts

@@ -16,33 +16,13 @@ export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: ReadonlyA
  *
  * This function is variadic, meaning that you can specify N sets.
  */
-export declare function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T>;
+export declare function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): ReadonlySet<T>;
 /** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
-export declare function copySet<T>(oldSet: ReadonlySet<T>): Set<T>;
-/**
- * Helper function to convert the keys of an object to a read-only set.
- *
- * Also see the `objectKeysToSet` function.
- */
-export declare function objectKeysToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<K>;
-/**
- * Helper function to convert the keys of an object to a set.
- *
- * Also see the `objectKeysToReadonlySet` function.
- */
-export declare function objectKeysToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<K>;
-/**
- * Helper function to convert the values of an object to a read-only set.
- *
- * Also see the `objectValuesToSet` function.
- */
-export declare function objectValuesToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<V>;
-/**
- * Helper function to convert the values of an object to a set.
- *
- * Also see the `objectValuesToReadonlySet` function.
- */
-export declare function objectValuesToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<V>;
+export declare function copySet<T>(oldSet: ReadonlySet<T>): ReadonlySet<T>;
+/** Helper function to convert the keys of an object to a set. */
+export declare function objectKeysToSet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<K>;
+/** Helper function to convert the values of an object to a set. */
+export declare function objectValuesToSet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<V>;
 /**
  * Helper function to add one or more elements to a set at once without having to repeatedly call
  * the `Set.add` method.

package/dist/functions/set.d.mts

@@ -16,33 +16,13 @@ export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: ReadonlyA
  *
  * This function is variadic, meaning that you can specify N sets.
  */
-export declare function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T>;
+export declare function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): ReadonlySet<T>;
 /** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
-export declare function copySet<T>(oldSet: ReadonlySet<T>): Set<T>;
-/**
- * Helper function to convert the keys of an object to a read-only set.
- *
- * Also see the `objectKeysToSet` function.
- */
-export declare function objectKeysToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<K>;
-/**
- * Helper function to convert the keys of an object to a set.
- *
- * Also see the `objectKeysToReadonlySet` function.
- */
-export declare function objectKeysToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<K>;
-/**
- * Helper function to convert the values of an object to a read-only set.
- *
- * Also see the `objectValuesToSet` function.
- */
-export declare function objectValuesToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<V>;
-/**
- * Helper function to convert the values of an object to a set.
- *
- * Also see the `objectValuesToReadonlySet` function.
- */
-export declare function objectValuesToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<V>;
+export declare function copySet<T>(oldSet: ReadonlySet<T>): ReadonlySet<T>;
+/** Helper function to convert the keys of an object to a set. */
+export declare function objectKeysToSet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<K>;
+/** Helper function to convert the values of an object to a set. */
+export declare function objectValuesToSet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<V>;
 /**
  * Helper function to add one or more elements to a set at once without having to repeatedly call
  * the `Set.add` method.

package/dist/functions/set.d.ts

@@ -16,33 +16,13 @@ export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: ReadonlyA
  *
  * This function is variadic, meaning that you can specify N sets.
  */
-export declare function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T>;
+export declare function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): ReadonlySet<T>;
 /** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
-export declare function copySet<T>(oldSet: ReadonlySet<T>): Set<T>;
-/**
- * Helper function to convert the keys of an object to a read-only set.
- *
- * Also see the `objectKeysToSet` function.
- */
-export declare function objectKeysToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<K>;
-/**
- * Helper function to convert the keys of an object to a set.
- *
- * Also see the `objectKeysToReadonlySet` function.
- */
-export declare function objectKeysToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<K>;
-/**
- * Helper function to convert the values of an object to a read-only set.
- *
- * Also see the `objectValuesToSet` function.
- */
-export declare function objectValuesToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<V>;
-/**
- * Helper function to convert the values of an object to a set.
- *
- * Also see the `objectValuesToReadonlySet` function.
- */
-export declare function objectValuesToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<V>;
+export declare function copySet<T>(oldSet: ReadonlySet<T>): ReadonlySet<T>;
+/** Helper function to convert the keys of an object to a set. */
+export declare function objectKeysToSet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<K>;
+/** Helper function to convert the values of an object to a set. */
+export declare function objectValuesToSet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<V>;
 /**
  * Helper function to add one or more elements to a set at once without having to repeatedly call
  * the `Set.add` method.

package/dist/functions/set.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"set.d.ts","sourceRoot":"","sources":["../../src/functions/set.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAE5B,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,EACf,GAAG,SAAS,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAC1C,IAAI,CAMN;AAED;;;;GAIG;AAEH,wBAAgB,WAAW,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAS7E;AAED,mGAAmG;AAEnG,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAOzD;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EAC3E,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,WAAW,CAAC,CAAC,CAAC,CAEhB;AAED;;;;GAIG;AAEH,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EACnE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,GAAG,CAAC,CAAC,CAAC,CAQR;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAClC,CAAC,EACD,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAEtC;AAED;;;;GAIG;AAEH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EACrE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,GAAG,CAAC,CAAC,CAAC,CAQR;AAED;;;;;GAKG;AAEH,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,SAAS,CAAC,EAAE,GAAG,IAAI,CAItE;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,CAAC,EACtB,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,EACnB,GAAG,QAAQ,EAAE,SAAS,CAAC,EAAE,GACxB,OAAO,CAET"}
+{"version":3,"file":"set.d.ts","sourceRoot":"","sources":["../../src/functions/set.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAE5B,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,EACf,GAAG,SAAS,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAC1C,IAAI,CAMN;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,GAAG,IAAI,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GACrC,WAAW,CAAC,CAAC,CAAC,CAShB;AAED,mGAAmG;AACnG,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAOjE;AAED,iEAAiE;AACjE,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EACnE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,WAAW,CAAC,CAAC,CAAC,CAQhB;AAED,mEAAmE;AACnE,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EACrE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,WAAW,CAAC,CAAC,CAAC,CAQhB;AAED;;;;;GAKG;AAEH,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,SAAS,CAAC,EAAE,GAAG,IAAI,CAItE;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,CAAC,EACtB,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,EACnB,GAAG,QAAQ,EAAE,SAAS,CAAC,EAAE,GACxB,OAAO,CAET"}

package/dist/functions/sort.d.cts

@@ -10,5 +10,5 @@
  * From:
  * https://stackoverflow.com/questions/8996963/how-to-perform-case-insensitive-sorting-array-of-string-in-javascript
  */
-export declare function sortCaseInsensitive(array: readonly string[]): string[];
+export declare function sortCaseInsensitive(array: readonly string[]): readonly string[];
 //# sourceMappingURL=sort.d.ts.map

package/dist/functions/sort.d.mts

@@ -10,5 +10,5 @@
  * From:
  * https://stackoverflow.com/questions/8996963/how-to-perform-case-insensitive-sorting-array-of-string-in-javascript
  */
-export declare function sortCaseInsensitive(array: readonly string[]): string[];
+export declare function sortCaseInsensitive(array: readonly string[]): readonly string[];
 //# sourceMappingURL=sort.d.ts.map

package/dist/functions/sort.d.ts

@@ -10,5 +10,5 @@
  * From:
  * https://stackoverflow.com/questions/8996963/how-to-perform-case-insensitive-sorting-array-of-string-in-javascript
  */
-export declare function sortCaseInsensitive(array: readonly string[]): string[];
+export declare function sortCaseInsensitive(array: readonly string[]): readonly string[];
 //# sourceMappingURL=sort.d.ts.map

package/dist/functions/sort.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sort.d.ts","sourceRoot":"","sources":["../../src/functions/sort.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;GAMG;AAEH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,CAStE"}
+{"version":3,"file":"sort.d.ts","sourceRoot":"","sources":["../../src/functions/sort.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,SAAS,MAAM,EAAE,GACvB,SAAS,MAAM,EAAE,CASnB"}

package/dist/index.cjs

@@ -192,8 +192,8 @@ function mapFilter(map, predicate) {
   return array;
 }
 function mapFind(map, predicate) {
-  for (const value of map.values()) {
-    const match = predicate(value);
+  for (const [key, value] of map) {
+    const match = predicate(value, key, map);
     if (match) {
       return value;
     }
@@ -223,9 +223,6 @@ function objectToMap(object) {
   }
   return map;
 }
-function objectToReadonlyMap(object) {
-  return objectToMap(object);
-}
 function objectToReverseMap(object) {
   const map = /* @__PURE__ */ new Map();
   for (const [key, value] of Object.entries(object)) {
@@ -233,9 +230,6 @@ function objectToReverseMap(object) {
   }
   return map;
 }
-function objectToReverseReadonlyMap(object) {
-  return objectToReverseMap(object);
-}
 
 function addSetsToSet(mainSet, ...setsToAdd) {
   for (const set of setsToAdd) {
@@ -260,9 +254,6 @@ function copySet(oldSet) {
   }
   return newSet;
 }
-function objectKeysToReadonlySet(object) {
-  return objectKeysToSet(object);
-}
 function objectKeysToSet(object) {
   const set = /* @__PURE__ */ new Set();
   for (const key of Object.keys(object)) {
@@ -270,9 +261,6 @@ function objectKeysToSet(object) {
   }
   return set;
 }
-function objectValuesToReadonlySet(object) {
-  return objectValuesToSet(object);
-}
 function objectValuesToSet(object) {
   const set = /* @__PURE__ */ new Set();
   for (const key of Object.values(object)) {
@@ -564,13 +552,9 @@ exports.newArray = newArray;
 exports.noop = noop;
 exports.normalizeString = normalizeString;
 exports.objectFilter = objectFilter;
-exports.objectKeysToReadonlySet = objectKeysToReadonlySet;
 exports.objectKeysToSet = objectKeysToSet;
 exports.objectToMap = objectToMap;
-exports.objectToReadonlyMap = objectToReadonlyMap;
 exports.objectToReverseMap = objectToReverseMap;
-exports.objectToReverseReadonlyMap = objectToReverseReadonlyMap;
-exports.objectValuesToReadonlySet = objectValuesToReadonlySet;
 exports.objectValuesToSet = objectValuesToSet;
 exports.parseFloatSafe = parseFloatSafe;
 exports.parseIntSafe = parseIntSafe;

package/dist/index.d.cts

@@ -24,6 +24,7 @@ export type * from "./types/ObjectValues.js";
 export * from "./types/ReadonlyMap.js";
 export type * from "./types/ReadonlyRecord.js";
 export * from "./types/ReadonlySet.js";
+export type * from "./types/TranspiledEnum.js";
 export type * from "./types/Tuple.js";
 export type * from "./types/WidenLiteral.js";
 export type * from "./types/Writeable.js";

package/dist/index.d.mts

@@ -24,6 +24,7 @@ export type * from "./types/ObjectValues.js";
 export * from "./types/ReadonlyMap.js";
 export type * from "./types/ReadonlyRecord.js";
 export * from "./types/ReadonlySet.js";
+export type * from "./types/TranspiledEnum.js";
 export type * from "./types/Tuple.js";
 export type * from "./types/WidenLiteral.js";
 export type * from "./types/Writeable.js";

package/dist/index.d.ts

@@ -24,6 +24,7 @@ export type * from "./types/ObjectValues.js";
 export * from "./types/ReadonlyMap.js";
 export type * from "./types/ReadonlyRecord.js";
 export * from "./types/ReadonlySet.js";
+export type * from "./types/TranspiledEnum.js";
 export type * from "./types/Tuple.js";
 export type * from "./types/WidenLiteral.js";
 export type * from "./types/Writeable.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,mBAAmB,wBAAwB,CAAC;AAC5C,mBAAmB,yCAAyC,CAAC;AAC7D,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,4CAA4C,CAAC;AAChE,mBAAmB,yBAAyB,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,mBAAmB,2BAA2B,CAAC;AAC/C,cAAc,wBAAwB,CAAC;AACvC,mBAAmB,kBAAkB,CAAC;AACtC,mBAAmB,yBAAyB,CAAC;AAC7C,mBAAmB,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,mBAAmB,wBAAwB,CAAC;AAC5C,mBAAmB,yCAAyC,CAAC;AAC7D,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,4CAA4C,CAAC;AAChE,mBAAmB,yBAAyB,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,mBAAmB,2BAA2B,CAAC;AAC/C,cAAc,wBAAwB,CAAC;AACvC,mBAAmB,2BAA2B,CAAC;AAC/C,mBAAmB,kBAAkB,CAAC;AACtC,mBAAmB,yBAAyB,CAAC;AAC7C,mBAAmB,sBAAsB,CAAC"}

package/dist/index.mjs

@@ -190,8 +190,8 @@ function mapFilter(map, predicate) {
   return array;
 }
 function mapFind(map, predicate) {
-  for (const value of map.values()) {
-    const match = predicate(value);
+  for (const [key, value] of map) {
+    const match = predicate(value, key, map);
     if (match) {
       return value;
     }
@@ -221,9 +221,6 @@ function objectToMap(object) {
   }
   return map;
 }
-function objectToReadonlyMap(object) {
-  return objectToMap(object);
-}
 function objectToReverseMap(object) {
   const map = /* @__PURE__ */ new Map();
   for (const [key, value] of Object.entries(object)) {
@@ -231,9 +228,6 @@ function objectToReverseMap(object) {
   }
   return map;
 }
-function objectToReverseReadonlyMap(object) {
-  return objectToReverseMap(object);
-}
 
 function addSetsToSet(mainSet, ...setsToAdd) {
   for (const set of setsToAdd) {
@@ -258,9 +252,6 @@ function copySet(oldSet) {
   }
   return newSet;
 }
-function objectKeysToReadonlySet(object) {
-  return objectKeysToSet(object);
-}
 function objectKeysToSet(object) {
   const set = /* @__PURE__ */ new Set();
   for (const key of Object.keys(object)) {
@@ -268,9 +259,6 @@ function objectKeysToSet(object) {
   }
   return set;
 }
-function objectValuesToReadonlySet(object) {
-  return objectValuesToSet(object);
-}
 function objectValuesToSet(object) {
   const set = /* @__PURE__ */ new Set();
   for (const key of Object.values(object)) {
@@ -508,4 +496,4 @@ function* tupleKeys(tuple) {
 
 const ReadonlyMap = Map;
 
-export { HOUR_IN_MILLISECONDS, MINUTE_IN_MILLISECONDS, ReadonlyMap, ReadonlySet, SECOND_IN_MILLISECONDS, addSetsToSet, arrayCopyTwoDimensional, arrayEquals, arrayRemove, arrayRemoveInPlace, assertArray, assertBoolean, assertDefined, assertEnumValue, assertNotNull, assertNumber, assertObject, assertString, capitalizeFirstLetter, clamp, combineSets, copySet, eRange, emptyArray, escapeHTMLCharacters, filterMap, getElapsedSeconds, getEnumEntries, getEnumKeys, getEnumValues, getNumConsecutiveDiacritics, getRandomArrayElement, getRandomArrayIndex, getRandomInt, hasDiacritic, hasEmoji, hasWhitespace, iRange, includes, interfaceSatisfiesEnum, isArray, isEnumValue, isFirstLetterCapitalized, isKebabCase, isKeyOf, isObject, isSemanticVersion, kebabCaseToCamelCase, mapFilter, mapFind, newArray, noop, normalizeString, objectFilter, objectKeysToReadonlySet, objectKeysToSet, objectToMap, objectToReadonlyMap, objectToReverseMap, objectToReverseReadonlyMap, objectValuesToReadonlySet, objectValuesToSet, parseFloatSafe, parseIntSafe, parseSemanticVersion, removeLinesBetweenMarkers, removeLinesMatching, removeNonPrintableCharacters, removeWhitespace, repeat, setAdd, setHas, sortCaseInsensitive, sumArray, todo, trimPrefix, trimSuffix, truncateString, tupleEntries, tupleKeys };
+export { HOUR_IN_MILLISECONDS, MINUTE_IN_MILLISECONDS, ReadonlyMap, ReadonlySet, SECOND_IN_MILLISECONDS, addSetsToSet, arrayCopyTwoDimensional, arrayEquals, arrayRemove, arrayRemoveInPlace, assertArray, assertBoolean, assertDefined, assertEnumValue, assertNotNull, assertNumber, assertObject, assertString, capitalizeFirstLetter, clamp, combineSets, copySet, eRange, emptyArray, escapeHTMLCharacters, filterMap, getElapsedSeconds, getEnumEntries, getEnumKeys, getEnumValues, getNumConsecutiveDiacritics, getRandomArrayElement, getRandomArrayIndex, getRandomInt, hasDiacritic, hasEmoji, hasWhitespace, iRange, includes, interfaceSatisfiesEnum, isArray, isEnumValue, isFirstLetterCapitalized, isKebabCase, isKeyOf, isObject, isSemanticVersion, kebabCaseToCamelCase, mapFilter, mapFind, newArray, noop, normalizeString, objectFilter, objectKeysToSet, objectToMap, objectToReverseMap, objectValuesToSet, parseFloatSafe, parseIntSafe, parseSemanticVersion, removeLinesBetweenMarkers, removeLinesMatching, removeNonPrintableCharacters, removeWhitespace, repeat, setAdd, setHas, sortCaseInsensitive, sumArray, todo, trimPrefix, trimSuffix, truncateString, tupleEntries, tupleKeys };

package/dist/types/TranspiledEnum.d.cts

@@ -0,0 +1,3 @@
+/** Helper type to represent a TypeScript `enum` at run-time. */
+export type TranspiledEnum = Record<string, string | number>;
+//# sourceMappingURL=TranspiledEnum.d.ts.map

package/dist/types/TranspiledEnum.d.mts

@@ -0,0 +1,3 @@
+/** Helper type to represent a TypeScript `enum` at run-time. */
+export type TranspiledEnum = Record<string, string | number>;
+//# sourceMappingURL=TranspiledEnum.d.ts.map

package/dist/types/TranspiledEnum.d.ts

@@ -0,0 +1,3 @@
+/** Helper type to represent a TypeScript `enum` at run-time. */
+export type TranspiledEnum = Record<string, string | number>;
+//# sourceMappingURL=TranspiledEnum.d.ts.map

package/dist/types/TranspiledEnum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TranspiledEnum.d.ts","sourceRoot":"","sources":["../../src/types/TranspiledEnum.ts"],"names":[],"mappings":"AAAA,gEAAgE;AAChE,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "complete-common",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "description": "Helper functions for TypeScript projects.",
   "keywords": [],
   "homepage": "https://complete-ts.github.io/",
@@ -35,7 +35,7 @@
     "test": "glob \"./src/**/*.test.ts\" --cmd=\"node --import tsx --test --test-reporter spec\""
   },
   "devDependencies": {
-    "@types/node": "22.13.9",
+    "@types/node": "22.13.10",
     "complete-node": "5.1.1",
     "eslint-plugin-sort-exports": "0.9.1",
     "glob": "11.0.1",

package/src/functions/array.ts

@@ -13,10 +13,9 @@ import { getRandomInt } from "./random.js";
  * Helper function to copy a two-dimensional array. Note that the sub-arrays will only be shallow
  * copied (using the spread operator).
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function arrayCopyTwoDimensional<T>(
   array: ReadonlyArray<readonly T[]>,
-): T[][] {
+): readonly T[][] {
   const copiedArray: T[][] = [];
 
   for (const subArray of array) {
@@ -51,11 +50,10 @@ export function arrayEquals<T>(
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function arrayRemove<T>(
   originalArray: readonly T[],
   ...elementsToRemove: readonly T[]
-): T[] {
+): readonly T[] {
   const elementsToRemoveSet = new ReadonlySet(elementsToRemove);
 
   const array: T[] = [];
@@ -80,12 +78,11 @@ export function arrayRemove<T>(
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function arrayRemoveInPlace<T>(
   // eslint-disable-next-line complete/prefer-readonly-parameter-types
   array: T[],
   ...elementsToRemove: readonly T[]
-): T[] {
+): readonly T[] {
   const removedElements: T[] = [];
 
   for (const element of elementsToRemove) {
@@ -116,11 +113,10 @@ export function emptyArray(array: unknown[]): void {
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function filterMap<OldT, NewT>(
   array: readonly OldT[],
   func: (element: OldT) => NewT | undefined,
-): NewT[] {
+): readonly NewT[] {
   const filteredArray: NewT[] = [];
 
   for (const element of array) {
@@ -204,8 +200,7 @@ export function isArray(arg: unknown): arg is unknown[] {
 }
 
 /** Initializes an array with all elements containing the specified default value. */
-// eslint-disable-next-line complete/no-mutable-return
-export function newArray<T>(length: number, value: T): T[] {
+export function newArray<T>(length: number, value: T): readonly T[] {
   return Array.from({ length }, () => value);
 }
 

package/src/functions/assert.ts

@@ -4,7 +4,7 @@
  * @module
  */
 
-import type { TranspiledEnum } from "./enums.js";
+import type { TranspiledEnum } from "../types/TranspiledEnum.js";
 import { isEnumValue } from "./enums.js";
 import { isObject } from "./types.js";
 

package/src/functions/enums.ts

@@ -4,7 +4,7 @@
  * @module
  */
 
-export type TranspiledEnum = Record<string, string | number>;
+import type { TranspiledEnum } from "../types/TranspiledEnum.js";
 
 /**
  * Helper function to get the entries of an enum.

package/src/functions/map.ts

@@ -14,11 +14,10 @@
  * If you want to perform a filter and a map at the same time on an array, use the `filterMap`
  * helper function instead.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function mapFilter<K, V>(
   map: ReadonlyMap<K, V>,
   predicate: (value: V) => boolean,
-): V[] {
+): readonly V[] {
   const array: V[] = [];
 
   for (const value of map.values()) {
@@ -36,13 +35,17 @@ export function mapFilter<K, V>(
  * maps.
  *
  * This is efficient such that it avoids converting the map values into an array.
+ *
+ * @param map The map to search through.
+ * @param predicate Function that tests each value for a condition.
+ * @returns The first value that satisfies the predicate, or undefined if no values satisfy.
  */
 export function mapFind<K, V>(
   map: ReadonlyMap<K, V>,
-  predicate: (value: V) => boolean,
+  predicate: (value: V, key: K, map: ReadonlyMap<K, V>) => boolean,
 ): V | undefined {
-  for (const value of map.values()) {
-    const match = predicate(value);
+  for (const [key, value] of map) {
+    const match = predicate(value, key, map);
     if (match) {
       return value;
     }

package/src/functions/object.ts

@@ -12,11 +12,10 @@ import type { ReadonlyRecord } from "../types/ReadonlyRecord.js";
  *
  * This is efficient such that it avoids converting the object values into an array.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function objectFilter<K extends string | number | symbol, V>(
   object: ReadonlyRecord<K, V>,
   predicate: (value: V) => boolean,
-): V[] {
+): readonly V[] {
   const array: V[] = [];
 
   // eslint-disable-next-line complete/no-for-in
@@ -41,13 +40,10 @@ export function objectFilter<K extends string | number | symbol, V>(
  *
  * Note that the converted map will only have string keys, due to the nature of JavaScript objects
  * only having string keys under the hood.
- *
- * Also see the `objectToReadonlyMap` function.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function objectToMap<K extends string | number | symbol, V>(
   object: Record<K, V>,
-): Map<K, V> {
+): ReadonlyMap<K, V> {
   const map = new Map<K, V>();
 
   for (const [key, value] of Object.entries(object)) {
@@ -57,38 +53,16 @@ export function objectToMap<K extends string | number | symbol, V>(
   return map;
 }
 
-/**
- * Helper function to convert an object to a read-only map.
- *
- * This is useful when you need to construct a type safe object with the `satisfies` operator, but
- * then later on you need to query it in a way where you expect the return value to be T or
- * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
- * assertions.
- *
- * Note that the converted map will only have string keys, due to the nature of JavaScript objects
- * only having string keys under the hood.
- *
- * Also see the `objectToMap` function.
- */
-export function objectToReadonlyMap<K extends string | number | symbol, V>(
-  object: Record<K, V>,
-): ReadonlyMap<K, V> {
-  return objectToMap(object);
-}
-
 /**
  * Helper function to convert an object to a reverse map.
  *
  * Note that the converted map will only have string keys, due to the nature of JavaScript objects
  * only having string keys under the hood.
- *
- * Also see the `objectToReverseReadonlyMap` function.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function objectToReverseMap<
   K extends string | number | symbol,
   V extends string | number | symbol,
->(object: Record<K, V>): Map<V, K> {
+>(object: Record<K, V>): ReadonlyMap<V, K> {
   const map = new Map<V, K>();
 
   for (const [key, value] of Object.entries(object)) {
@@ -97,18 +71,3 @@ export function objectToReverseMap<
 
   return map;
 }
-
-/**
- * Helper function to convert an object to a reverse read-only map.
- *
- * Note that the converted map will only have string keys, due to the nature of JavaScript objects
- * only having string keys under the hood.
- *
- * Also see the `objectToReverseMap` function.
- */
-export function objectToReverseReadonlyMap<
-  K extends string | number | symbol,
-  V extends string | number | symbol,
->(object: Record<K, V>): ReadonlyMap<V, K> {
-  return objectToReverseMap(object);
-}

package/src/functions/set.ts

@@ -28,8 +28,9 @@ export function addSetsToSet<T>(
  *
  * This function is variadic, meaning that you can specify N sets.
  */
-// eslint-disable-next-line complete/no-mutable-return
-export function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T> {
+export function combineSets<T>(
+  ...sets: ReadonlyArray<ReadonlySet<T>>
+): ReadonlySet<T> {
   const newSet = new Set<T>();
   for (const set of sets) {
     for (const value of set) {
@@ -41,8 +42,7 @@ export function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T> {
 }
 
 /** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
-// eslint-disable-next-line complete/no-mutable-return
-export function copySet<T>(oldSet: ReadonlySet<T>): Set<T> {
+export function copySet<T>(oldSet: ReadonlySet<T>): ReadonlySet<T> {
   const newSet = new Set<T>();
   for (const value of oldSet) {
     newSet.add(value);
@@ -51,26 +51,10 @@ export function copySet<T>(oldSet: ReadonlySet<T>): Set<T> {
   return newSet;
 }
 
-/**
- * Helper function to convert the keys of an object to a read-only set.
- *
- * Also see the `objectKeysToSet` function.
- */
-export function objectKeysToReadonlySet<K extends string | number | symbol, V>(
-  object: Record<K, V>,
-): ReadonlySet<K> {
-  return objectKeysToSet(object);
-}
-
-/**
- * Helper function to convert the keys of an object to a set.
- *
- * Also see the `objectKeysToReadonlySet` function.
- */
-// eslint-disable-next-line complete/no-mutable-return
+/** Helper function to convert the keys of an object to a set. */
 export function objectKeysToSet<K extends string | number | symbol, V>(
   object: Record<K, V>,
-): Set<K> {
+): ReadonlySet<K> {
   const set = new Set<K>();
 
   for (const key of Object.keys(object)) {
@@ -80,27 +64,10 @@ export function objectKeysToSet<K extends string | number | symbol, V>(
   return set;
 }
 
-/**
- * Helper function to convert the values of an object to a read-only set.
- *
- * Also see the `objectValuesToSet` function.
- */
-export function objectValuesToReadonlySet<
-  K extends string | number | symbol,
-  V,
->(object: Record<K, V>): ReadonlySet<V> {
-  return objectValuesToSet(object);
-}
-
-/**
- * Helper function to convert the values of an object to a set.
- *
- * Also see the `objectValuesToReadonlySet` function.
- */
-// eslint-disable-next-line complete/no-mutable-return
+/** Helper function to convert the values of an object to a set. */
 export function objectValuesToSet<K extends string | number | symbol, V>(
   object: Record<K, V>,
-): Set<V> {
+): ReadonlySet<V> {
   const set = new Set<V>();
 
   for (const key of Object.values(object)) {

package/src/functions/sort.ts

@@ -11,8 +11,9 @@
  * From:
  * https://stackoverflow.com/questions/8996963/how-to-perform-case-insensitive-sorting-array-of-string-in-javascript
  */
-// eslint-disable-next-line complete/no-mutable-return
-export function sortCaseInsensitive(array: readonly string[]): string[] {
+export function sortCaseInsensitive(
+  array: readonly string[],
+): readonly string[] {
   const newArray = [...array];
   newArray.sort((a, b) =>
     a.localeCompare(b, undefined, {

package/src/index.ts

@@ -24,6 +24,7 @@ export type * from "./types/ObjectValues.js";
 export * from "./types/ReadonlyMap.js";
 export type * from "./types/ReadonlyRecord.js";
 export * from "./types/ReadonlySet.js";
+export type * from "./types/TranspiledEnum.js";
 export type * from "./types/Tuple.js";
 export type * from "./types/WidenLiteral.js";
 export type * from "./types/Writeable.js";

package/src/types/TranspiledEnum.ts

@@ -0,0 +1,2 @@
+/** Helper type to represent a TypeScript `enum` at run-time. */
+export type TranspiledEnum = Record<string, string | number>;