complete-common 1.3.0 → 1.4.0

package/dist/functions/array.d.cts

@@ -36,7 +36,7 @@ export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsT
  */
 export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: readonly T[]): T[];
 /** Helper function to remove all of the elements in an array in-place. */
-export declare function emptyArray<T>(array: T[]): void;
+export declare function emptyArray(array: unknown[]): void;
 /**
  * Helper function to perform a filter and a map at the same time. Similar to `Array.map`, provide a
  * function that transforms a value, but return `undefined` if the value should be skipped. (Thus,
@@ -66,7 +66,7 @@ export declare function getRandomArrayElement<T>(array: readonly T[], exceptions
  * @param exceptions Optional. An array of indexes that will be skipped over when getting the random
  *                   index. Default is an empty array.
  */
-export declare function getRandomArrayIndex<T>(array: readonly T[], exceptions?: readonly number[]): number;
+export declare function getRandomArrayIndex(array: readonly unknown[], exceptions?: readonly number[]): number;
 /**
  * Similar to the `Array.includes` method, but works on a widened version of the array.
  *

package/dist/functions/array.d.mts

@@ -36,7 +36,7 @@ export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsT
  */
 export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: readonly T[]): T[];
 /** Helper function to remove all of the elements in an array in-place. */
-export declare function emptyArray<T>(array: T[]): void;
+export declare function emptyArray(array: unknown[]): void;
 /**
  * Helper function to perform a filter and a map at the same time. Similar to `Array.map`, provide a
  * function that transforms a value, but return `undefined` if the value should be skipped. (Thus,
@@ -66,7 +66,7 @@ export declare function getRandomArrayElement<T>(array: readonly T[], exceptions
  * @param exceptions Optional. An array of indexes that will be skipped over when getting the random
  *                   index. Default is an empty array.
  */
-export declare function getRandomArrayIndex<T>(array: readonly T[], exceptions?: readonly number[]): number;
+export declare function getRandomArrayIndex(array: readonly unknown[], exceptions?: readonly number[]): number;
 /**
  * Similar to the `Array.includes` method, but works on a widened version of the array.
  *

package/dist/functions/array.d.ts

@@ -36,7 +36,7 @@ export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsT
  */
 export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: readonly T[]): T[];
 /** Helper function to remove all of the elements in an array in-place. */
-export declare function emptyArray<T>(array: T[]): void;
+export declare function emptyArray(array: unknown[]): void;
 /**
  * Helper function to perform a filter and a map at the same time. Similar to `Array.map`, provide a
  * function that transforms a value, but return `undefined` if the value should be skipped. (Thus,
@@ -66,7 +66,7 @@ export declare function getRandomArrayElement<T>(array: readonly T[], exceptions
  * @param exceptions Optional. An array of indexes that will be skipped over when getting the random
  *                   index. Default is an empty array.
  */
-export declare function getRandomArrayIndex<T>(array: readonly T[], exceptions?: readonly number[]): number;
+export declare function getRandomArrayIndex(array: readonly unknown[], exceptions?: readonly number[]): number;
 /**
  * Similar to the `Array.includes` method, but works on a widened version of the array.
  *

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,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,IAAI,CAE9C;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,CAAC,CAAC,EACnC,KAAK,EAAE,SAAS,CAAC,EAAE,EACnB,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;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"}

package/dist/functions/assert.d.cts

@@ -3,6 +3,7 @@
  *
  * @module
  */
+import type { TranspiledEnum } from "./enums.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. */
@@ -15,6 +16,17 @@ export declare function assertBoolean(value: unknown, msg: string): asserts valu
 export declare function assertDefined<T>(value: T, ...[msg]: [undefined] extends [T] ? [string] : [
     "The assertion is useless because the provided value does not contain undefined."
 ]): asserts value is Exclude<T, undefined>;
+/**
+ * Helper function to throw an error if the provided value is not contained within an enum.
+ *
+ * @param value The value to check.
+ * @param transpiledEnum The enum to check against.
+ * @param msg The error message to throw if the check fails.
+ * @param set Optional. A set that contains all of the values of an enum. If provided, this function
+ *            will check for existence using the set (instead of the enum itself). Using a set
+ *            should be more performant for enums with around 52 or more elements.
+ */
+export declare function assertEnumValue<T extends TranspiledEnum>(value: number | string, transpiledEnum: T, msg: string, set?: ReadonlySet<string | number>): asserts value is T[keyof T];
 /**
  * Helper function to throw an error if the provided value is equal to `null`.
  *

package/dist/functions/assert.d.mts

@@ -3,6 +3,7 @@
  *
  * @module
  */
+import type { TranspiledEnum } from "./enums.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. */
@@ -15,6 +16,17 @@ export declare function assertBoolean(value: unknown, msg: string): asserts valu
 export declare function assertDefined<T>(value: T, ...[msg]: [undefined] extends [T] ? [string] : [
     "The assertion is useless because the provided value does not contain undefined."
 ]): asserts value is Exclude<T, undefined>;
+/**
+ * Helper function to throw an error if the provided value is not contained within an enum.
+ *
+ * @param value The value to check.
+ * @param transpiledEnum The enum to check against.
+ * @param msg The error message to throw if the check fails.
+ * @param set Optional. A set that contains all of the values of an enum. If provided, this function
+ *            will check for existence using the set (instead of the enum itself). Using a set
+ *            should be more performant for enums with around 52 or more elements.
+ */
+export declare function assertEnumValue<T extends TranspiledEnum>(value: number | string, transpiledEnum: T, msg: string, set?: ReadonlySet<string | number>): asserts value is T[keyof T];
 /**
  * Helper function to throw an error if the provided value is equal to `null`.
  *

package/dist/functions/assert.d.ts

@@ -3,6 +3,7 @@
  *
  * @module
  */
+import type { TranspiledEnum } from "./enums.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. */
@@ -15,6 +16,17 @@ export declare function assertBoolean(value: unknown, msg: string): asserts valu
 export declare function assertDefined<T>(value: T, ...[msg]: [undefined] extends [T] ? [string] : [
     "The assertion is useless because the provided value does not contain undefined."
 ]): asserts value is Exclude<T, undefined>;
+/**
+ * Helper function to throw an error if the provided value is not contained within an enum.
+ *
+ * @param value The value to check.
+ * @param transpiledEnum The enum to check against.
+ * @param msg The error message to throw if the check fails.
+ * @param set Optional. A set that contains all of the values of an enum. If provided, this function
+ *            will check for existence using the set (instead of the enum itself). Using a set
+ *            should be more performant for enums with around 52 or more elements.
+ */
+export declare function assertEnumValue<T extends TranspiledEnum>(value: number | string, transpiledEnum: T, msg: string, set?: ReadonlySet<string | number>): asserts value is T[keyof T];
 /**
  * Helper function to throw an error if the provided value is equal to `null`.
  *

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;AAIH,+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;;;;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,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"}

package/dist/functions/enums.d.cts

@@ -3,7 +3,7 @@
  *
  * @module
  */
-type TranspiledEnum = Record<string, string | number>;
+export type TranspiledEnum = Record<string, string | number>;
 /**
  * Helper function to get the entries of an enum.
  *
@@ -69,5 +69,4 @@ export declare function interfaceSatisfiesEnum<T extends Record<Enum, unknown>,
  *            should be more performant for enums with around 52 or more elements.
  */
 export declare function isEnumValue<T extends TranspiledEnum>(value: number | string, transpiledEnum: T, set?: ReadonlySet<string | number>): value is T[keyof T];
-export {};
 //# sourceMappingURL=enums.d.ts.map

package/dist/functions/enums.d.mts

@@ -3,7 +3,7 @@
  *
  * @module
  */
-type TranspiledEnum = Record<string, string | number>;
+export type TranspiledEnum = Record<string, string | number>;
 /**
  * Helper function to get the entries of an enum.
  *
@@ -69,5 +69,4 @@ export declare function interfaceSatisfiesEnum<T extends Record<Enum, unknown>,
  *            should be more performant for enums with around 52 or more elements.
  */
 export declare function isEnumValue<T extends TranspiledEnum>(value: number | string, transpiledEnum: T, set?: ReadonlySet<string | number>): value is T[keyof T];
-export {};
 //# sourceMappingURL=enums.d.ts.map

package/dist/functions/enums.d.ts

@@ -3,7 +3,7 @@
  *
  * @module
  */
-type TranspiledEnum = Record<string, string | number>;
+export type TranspiledEnum = Record<string, string | number>;
 /**
  * Helper function to get the entries of an enum.
  *
@@ -69,5 +69,4 @@ export declare function interfaceSatisfiesEnum<T extends Record<Enum, unknown>,
  *            should be more performant for enums with around 52 or more elements.
  */
 export declare function isEnumValue<T extends TranspiledEnum>(value: number | string, transpiledEnum: T, set?: ReadonlySet<string | number>): value is T[keyof T];
-export {};
 //# sourceMappingURL=enums.d.ts.map

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,KAAK,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;AAEtD;;;;;;;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,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"}

package/dist/index.cjs

@@ -6,6 +6,32 @@ const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;
 
 const ReadonlySet = Set;
 
+function getEnumEntries(transpiledEnum) {
+  const entries = Object.entries(transpiledEnum);
+  const numberEntries = entries.filter(
+    ([_key, value]) => typeof value === "number"
+  );
+  const entriesToReturn = numberEntries.length > 0 ? numberEntries : entries;
+  return entriesToReturn;
+}
+function getEnumKeys(transpiledEnum) {
+  const enumEntries = getEnumEntries(transpiledEnum);
+  return enumEntries.map(([key, _value]) => key);
+}
+function getEnumValues(transpiledEnum) {
+  const enumEntries = getEnumEntries(transpiledEnum);
+  return enumEntries.map(([_key, value]) => value);
+}
+function interfaceSatisfiesEnum() {
+}
+function isEnumValue(value, transpiledEnum, set) {
+  if (set !== void 0) {
+    return set.has(value);
+  }
+  const enumValues = getEnumValues(transpiledEnum);
+  return enumValues.includes(value);
+}
+
 function isObject(variable) {
   return typeof variable === "object" && variable !== null && !Array.isArray(variable);
 }
@@ -25,6 +51,11 @@ function assertDefined(value, ...[msg]) {
     throw new TypeError(msg);
   }
 }
+function assertEnumValue(value, transpiledEnum, msg, set) {
+  if (!isEnumValue(value, transpiledEnum, set)) {
+    throw new TypeError(msg);
+  }
+}
 function assertNotNull(value, ...[msg]) {
   if (value === null) {
     throw new TypeError(msg);
@@ -150,32 +181,6 @@ function sumArray(array) {
   return array.reduce((accumulator, element) => accumulator + element, 0);
 }
 
-function getEnumEntries(transpiledEnum) {
-  const entries = Object.entries(transpiledEnum);
-  const numberEntries = entries.filter(
-    ([_key, value]) => typeof value === "number"
-  );
-  const entriesToReturn = numberEntries.length > 0 ? numberEntries : entries;
-  return entriesToReturn;
-}
-function getEnumKeys(transpiledEnum) {
-  const enumEntries = getEnumEntries(transpiledEnum);
-  return enumEntries.map(([key, _value]) => key);
-}
-function getEnumValues(transpiledEnum) {
-  const enumEntries = getEnumEntries(transpiledEnum);
-  return enumEntries.map(([_key, value]) => value);
-}
-function interfaceSatisfiesEnum() {
-}
-function isEnumValue(value, transpiledEnum, set) {
-  if (set !== void 0) {
-    return set.has(value);
-  }
-  const enumValues = getEnumValues(transpiledEnum);
-  return enumValues.includes(value);
-}
-
 function mapFilter(map, predicate) {
   const array = [];
   for (const value of map.values()) {
@@ -518,6 +523,7 @@ exports.arrayRemoveInPlace = arrayRemoveInPlace;
 exports.assertArray = assertArray;
 exports.assertBoolean = assertBoolean;
 exports.assertDefined = assertDefined;
+exports.assertEnumValue = assertEnumValue;
 exports.assertNotNull = assertNotNull;
 exports.assertNumber = assertNumber;
 exports.assertObject = assertObject;

package/dist/index.mjs

@@ -4,6 +4,32 @@ const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;
 
 const ReadonlySet = Set;
 
+function getEnumEntries(transpiledEnum) {
+  const entries = Object.entries(transpiledEnum);
+  const numberEntries = entries.filter(
+    ([_key, value]) => typeof value === "number"
+  );
+  const entriesToReturn = numberEntries.length > 0 ? numberEntries : entries;
+  return entriesToReturn;
+}
+function getEnumKeys(transpiledEnum) {
+  const enumEntries = getEnumEntries(transpiledEnum);
+  return enumEntries.map(([key, _value]) => key);
+}
+function getEnumValues(transpiledEnum) {
+  const enumEntries = getEnumEntries(transpiledEnum);
+  return enumEntries.map(([_key, value]) => value);
+}
+function interfaceSatisfiesEnum() {
+}
+function isEnumValue(value, transpiledEnum, set) {
+  if (set !== void 0) {
+    return set.has(value);
+  }
+  const enumValues = getEnumValues(transpiledEnum);
+  return enumValues.includes(value);
+}
+
 function isObject(variable) {
   return typeof variable === "object" && variable !== null && !Array.isArray(variable);
 }
@@ -23,6 +49,11 @@ function assertDefined(value, ...[msg]) {
     throw new TypeError(msg);
   }
 }
+function assertEnumValue(value, transpiledEnum, msg, set) {
+  if (!isEnumValue(value, transpiledEnum, set)) {
+    throw new TypeError(msg);
+  }
+}
 function assertNotNull(value, ...[msg]) {
   if (value === null) {
     throw new TypeError(msg);
@@ -148,32 +179,6 @@ function sumArray(array) {
   return array.reduce((accumulator, element) => accumulator + element, 0);
 }
 
-function getEnumEntries(transpiledEnum) {
-  const entries = Object.entries(transpiledEnum);
-  const numberEntries = entries.filter(
-    ([_key, value]) => typeof value === "number"
-  );
-  const entriesToReturn = numberEntries.length > 0 ? numberEntries : entries;
-  return entriesToReturn;
-}
-function getEnumKeys(transpiledEnum) {
-  const enumEntries = getEnumEntries(transpiledEnum);
-  return enumEntries.map(([key, _value]) => key);
-}
-function getEnumValues(transpiledEnum) {
-  const enumEntries = getEnumEntries(transpiledEnum);
-  return enumEntries.map(([_key, value]) => value);
-}
-function interfaceSatisfiesEnum() {
-}
-function isEnumValue(value, transpiledEnum, set) {
-  if (set !== void 0) {
-    return set.has(value);
-  }
-  const enumValues = getEnumValues(transpiledEnum);
-  return enumValues.includes(value);
-}
-
 function mapFilter(map, predicate) {
   const array = [];
   for (const value of map.values()) {
@@ -503,4 +508,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, 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, 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "complete-common",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Helper functions for TypeScript projects.",
   "keywords": [],
   "homepage": "https://complete-ts.github.io/",
@@ -35,12 +35,12 @@
     "test": "glob \"./src/**/*.test.ts\" --cmd=\"node --import tsx --test --test-reporter spec\""
   },
   "devDependencies": {
-    "@types/node": "22.13.5",
-    "complete-node": "3.1.6",
+    "@types/node": "22.13.9",
+    "complete-node": "5.1.1",
     "eslint-plugin-sort-exports": "0.9.1",
     "glob": "11.0.1",
-    "typescript": "5.7.3",
-    "typescript-eslint": "8.25.0",
+    "typescript": "5.8.2",
+    "typescript-eslint": "8.26.0",
     "unbuild": "3.5.0"
   }
 }

package/src/functions/array.ts

@@ -101,7 +101,7 @@ export function arrayRemoveInPlace<T>(
 
 /** Helper function to remove all of the elements in an array in-place. */
 // eslint-disable-next-line complete/prefer-readonly-parameter-types
-export function emptyArray<T>(array: T[]): void {
+export function emptyArray(array: unknown[]): void {
   array.splice(0, array.length);
 }
 
@@ -171,8 +171,8 @@ export function getRandomArrayElement<T>(
  * @param exceptions Optional. An array of indexes that will be skipped over when getting the random
  *                   index. Default is an empty array.
  */
-export function getRandomArrayIndex<T>(
-  array: readonly T[],
+export function getRandomArrayIndex(
+  array: readonly unknown[],
   exceptions: readonly number[] = [],
 ): number {
   if (array.length === 0) {

package/src/functions/assert.ts

@@ -4,6 +4,8 @@
  * @module
  */
 
+import type { TranspiledEnum } from "./enums.js";
+import { isEnumValue } from "./enums.js";
 import { isObject } from "./types.js";
 
 /** Helper function to throw an error if the provided value is not an array. */
@@ -44,6 +46,27 @@ export function assertDefined<T>(
   }
 }
 
+/**
+ * Helper function to throw an error if the provided value is not contained within an enum.
+ *
+ * @param value The value to check.
+ * @param transpiledEnum The enum to check against.
+ * @param msg The error message to throw if the check fails.
+ * @param set Optional. A set that contains all of the values of an enum. If provided, this function
+ *            will check for existence using the set (instead of the enum itself). Using a set
+ *            should be more performant for enums with around 52 or more elements.
+ */
+export function assertEnumValue<T extends TranspiledEnum>(
+  value: number | string,
+  transpiledEnum: T,
+  msg: string,
+  set?: ReadonlySet<string | number>,
+): asserts value is T[keyof T] {
+  if (!isEnumValue(value, transpiledEnum, set)) {
+    throw new TypeError(msg);
+  }
+}
+
 /**
  * Helper function to throw an error if the provided value is equal to `null`.
  *

package/src/functions/enums.ts

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