complete-common 2.4.0 → 2.6.0

package/dist/functions/array.d.cts

@@ -19,9 +19,24 @@ export declare function arrayEquals<T>(array1: readonly T[], array2: readonly T[
  * array. If the specified element(s) are not found in the array, it will simply return a shallow
  * copy of the array.
  *
+ * If there is more than one matching element in the array, this function will remove all of them.
+ *
  * 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[]): readonly T[];
+/**
+ * Removes all of the specified element(s) from the array. If the specified element(s) are not found
+ * in the array, this function will do nothing.
+ *
+ * This function is variadic, meaning that you can specify N arguments to remove N elements.
+ *
+ * If there is more than one matching element in the array, this function will remove every matching
+ * element. If you want to only remove the first matching element, use the `arrayRemoveInPlace`
+ * function instead.
+ *
+ * @returns True if one or more elements were removed, false otherwise.
+ */
+export declare function arrayRemoveAllInPlace<T>(array: T[], ...elementsToRemove: readonly T[]): boolean;
 /**
  * Removes the specified element(s) from the array. If the specified element(s) are not found in the
  * array, this function will do nothing.
@@ -29,8 +44,7 @@ export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsT
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  *
  * If there is more than one matching element in the array, this function will only remove the first
- * matching element. If you want to remove all of the elements, use the `arrayRemoveAllInPlace`
- * function instead.
+ * one. If you want to remove all of the elements, use the `arrayRemoveAllInPlace` function instead.
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
@@ -81,7 +95,7 @@ export declare function includes<T, TupleElement extends WidenLiteral<T>>(array:
  */
 export declare function includesAny<T>(array: readonly T[], ...searchElements: readonly T[]): boolean;
 /** A wrapper around `Array.isArray` that narrows to `unknown[]` instead of `any[]`. */
-export declare function isArray(arg: unknown): arg is unknown[];
+export declare function isArray(variable: unknown): variable is unknown[];
 /** Initializes an array with all elements containing the specified default value. */
 export declare function newArray<T>(length: number, value: T): readonly T[];
 /** Helper function to sum every value in an array together. */

package/dist/functions/array.d.mts

@@ -19,9 +19,24 @@ export declare function arrayEquals<T>(array1: readonly T[], array2: readonly T[
  * array. If the specified element(s) are not found in the array, it will simply return a shallow
  * copy of the array.
  *
+ * If there is more than one matching element in the array, this function will remove all of them.
+ *
  * 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[]): readonly T[];
+/**
+ * Removes all of the specified element(s) from the array. If the specified element(s) are not found
+ * in the array, this function will do nothing.
+ *
+ * This function is variadic, meaning that you can specify N arguments to remove N elements.
+ *
+ * If there is more than one matching element in the array, this function will remove every matching
+ * element. If you want to only remove the first matching element, use the `arrayRemoveInPlace`
+ * function instead.
+ *
+ * @returns True if one or more elements were removed, false otherwise.
+ */
+export declare function arrayRemoveAllInPlace<T>(array: T[], ...elementsToRemove: readonly T[]): boolean;
 /**
  * Removes the specified element(s) from the array. If the specified element(s) are not found in the
  * array, this function will do nothing.
@@ -29,8 +44,7 @@ export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsT
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  *
  * If there is more than one matching element in the array, this function will only remove the first
- * matching element. If you want to remove all of the elements, use the `arrayRemoveAllInPlace`
- * function instead.
+ * one. If you want to remove all of the elements, use the `arrayRemoveAllInPlace` function instead.
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
@@ -81,7 +95,7 @@ export declare function includes<T, TupleElement extends WidenLiteral<T>>(array:
  */
 export declare function includesAny<T>(array: readonly T[], ...searchElements: readonly T[]): boolean;
 /** A wrapper around `Array.isArray` that narrows to `unknown[]` instead of `any[]`. */
-export declare function isArray(arg: unknown): arg is unknown[];
+export declare function isArray(variable: unknown): variable is unknown[];
 /** Initializes an array with all elements containing the specified default value. */
 export declare function newArray<T>(length: number, value: T): readonly T[];
 /** Helper function to sum every value in an array together. */

package/dist/functions/array.d.ts

@@ -19,9 +19,24 @@ export declare function arrayEquals<T>(array1: readonly T[], array2: readonly T[
  * array. If the specified element(s) are not found in the array, it will simply return a shallow
  * copy of the array.
  *
+ * If there is more than one matching element in the array, this function will remove all of them.
+ *
  * 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[]): readonly T[];
+/**
+ * Removes all of the specified element(s) from the array. If the specified element(s) are not found
+ * in the array, this function will do nothing.
+ *
+ * This function is variadic, meaning that you can specify N arguments to remove N elements.
+ *
+ * If there is more than one matching element in the array, this function will remove every matching
+ * element. If you want to only remove the first matching element, use the `arrayRemoveInPlace`
+ * function instead.
+ *
+ * @returns True if one or more elements were removed, false otherwise.
+ */
+export declare function arrayRemoveAllInPlace<T>(array: T[], ...elementsToRemove: readonly T[]): boolean;
 /**
  * Removes the specified element(s) from the array. If the specified element(s) are not found in the
  * array, this function will do nothing.
@@ -29,8 +44,7 @@ export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsT
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  *
  * If there is more than one matching element in the array, this function will only remove the first
- * matching element. If you want to remove all of the elements, use the `arrayRemoveAllInPlace`
- * function instead.
+ * one. If you want to remove all of the elements, use the `arrayRemoveAllInPlace` function instead.
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
@@ -81,7 +95,7 @@ export declare function includes<T, TupleElement extends WidenLiteral<T>>(array:
  */
 export declare function includesAny<T>(array: readonly T[], ...searchElements: readonly T[]): boolean;
 /** A wrapper around `Array.isArray` that narrows to `unknown[]` instead of `any[]`. */
-export declare function isArray(arg: unknown): arg is unknown[];
+export declare function isArray(variable: unknown): variable is unknown[];
 /** Initializes an array with all elements containing the specified default value. */
 export declare function newArray<T>(length: number, value: T): readonly T[];
 /** Helper function to sum every value in an array together. */

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;AAGH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAI7D;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EACvC,KAAK,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,GACjC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,CAQ7B;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;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,KAAK,EAAE,SAAS,CAAC,EAAE,EACnB,GAAG,cAAc,EAAE,SAAS,CAAC,EAAE,GAC9B,OAAO,CAET;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"}
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../src/functions/array.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAI7D;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EACvC,KAAK,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,GACjC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,CAQ7B;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,MAAM,EAAE,SAAS,CAAC,EAAE,EACpB,MAAM,EAAE,SAAS,CAAC,EAAE,GACnB,OAAO,CAST;AAED;;;;;;;;GAQG;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,qBAAqB,CAAC,CAAC,EAErC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,gBAAgB,EAAE,SAAS,CAAC,EAAE,GAChC,OAAO,CAeT;AAED;;;;;;;;;;GAUG;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;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,KAAK,EAAE,SAAS,CAAC,EAAE,EACnB,GAAG,cAAc,EAAE,SAAS,CAAC,EAAE,GAC9B,OAAO,CAET;AAED,uFAAuF;AACvF,wBAAgB,OAAO,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,OAAO,EAAE,CAEhE;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

@@ -27,6 +27,12 @@ export declare function assertDefined<T>(value: T, ...[msg]: [undefined] extends
  *            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 not an instance of the expected class.
+ *
+ * This is useful to have TypeScript narrow a value to a specific type in a concise way.
+ */
+export declare function assertIs<T extends abstract new (...args: unknown[]) => unknown>(value: unknown, constructor: T, msg: string): asserts value is InstanceType<T>;
 /**
  * Helper function to throw an error if the provided value is equal to `null`.
  *

package/dist/functions/assert.d.mts

@@ -27,6 +27,12 @@ export declare function assertDefined<T>(value: T, ...[msg]: [undefined] extends
  *            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 not an instance of the expected class.
+ *
+ * This is useful to have TypeScript narrow a value to a specific type in a concise way.
+ */
+export declare function assertIs<T extends abstract new (...args: unknown[]) => unknown>(value: unknown, constructor: T, msg: string): asserts value is InstanceType<T>;
 /**
  * Helper function to throw an error if the provided value is equal to `null`.
  *

package/dist/functions/assert.d.ts

@@ -27,6 +27,12 @@ export declare function assertDefined<T>(value: T, ...[msg]: [undefined] extends
  *            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 not an instance of the expected class.
+ *
+ * This is useful to have TypeScript narrow a value to a specific type in a concise way.
+ */
+export declare function assertIs<T extends abstract new (...args: unknown[]) => unknown>(value: unknown, constructor: T, msg: string): asserts value is InstanceType<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;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"}
+{"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,QAAQ,CACtB,CAAC,SAAS,QAAQ,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,EAEtD,KAAK,EAAE,OAAO,EACd,WAAW,EAAE,CAAC,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,YAAY,CAAC,CAAC,CAAC,CAIlC;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/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/functions/string.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAmBH,kEAAkE;AAClE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAU5D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAqBlE;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAOpD;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED,0FAA0F;AAC1F,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAErD;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAGhE;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,wEAAwE;AACxE,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED,yEAAyE;AACzE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAG5D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAiBtD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,MAAM,GACtD;IACE,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;IAErB,wDAAwD;IACxD,YAAY,EAAE,MAAM,CAAC;IAErB,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACtB,GACD,SAAS,CAwBZ;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,GACb,MAAM,CAuBR;AAED,gGAAgG;AAChG,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAIzE;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEnE;AAED,yEAAyE;AACzE,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,UAAQ,GACd,MAAM,CAWR;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAOjE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAMxE"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/functions/string.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAmBH,kEAAkE;AAClE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAU5D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAqBlE;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAOpD;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED,0FAA0F;AAC1F,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAErD;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAGhE;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,wEAAwE;AACxE,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED,yEAAyE;AACzE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAG5D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAiBtD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,MAAM,GACtD;IACE,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;IAErB,wDAAwD;IACxD,YAAY,EAAE,MAAM,CAAC;IAErB,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACtB,GACD,SAAS,CAwBZ;AAGD;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,GACb,MAAM,CAuBR;AAED,gGAAgG;AAChG,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAIzE;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEnE;AAED,yEAAyE;AACzE,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,UAAQ,GACd,MAAM,CAWR;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAOjE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAMxE"}

package/dist/index.cjs

@@ -56,6 +56,11 @@ function assertEnumValue(value, transpiledEnum, msg, set) {
     throw new TypeError(msg);
   }
 }
+function assertIs(value, constructor, msg) {
+  if (!(value instanceof constructor)) {
+    throw new TypeError(msg);
+  }
+}
 function assertNotNull(value, ...[msg]) {
   if (value === null) {
     throw new TypeError(msg);
@@ -120,6 +125,20 @@ function arrayRemove(originalArray, ...elementsToRemove) {
   }
   return array;
 }
+function arrayRemoveAllInPlace(array, ...elementsToRemove) {
+  let removedOneOrMoreElements = false;
+  for (const element of elementsToRemove) {
+    let index;
+    do {
+      index = array.indexOf(element);
+      if (index > -1) {
+        removedOneOrMoreElements = true;
+        array.splice(index, 1);
+      }
+    } while (index > -1);
+  }
+  return removedOneOrMoreElements;
+}
 function arrayRemoveInPlace(array, ...elementsToRemove) {
   const removedElements = [];
   for (const element of elementsToRemove) {
@@ -174,8 +193,8 @@ function includes(array, searchElement) {
 function includesAny(array, ...searchElements) {
   return searchElements.some((element) => array.includes(element));
 }
-function isArray(arg) {
-  return Array.isArray(arg);
+function isArray(variable) {
+  return Array.isArray(variable);
 }
 function newArray(length, value) {
   return Array.from({ length }, () => value);
@@ -522,11 +541,13 @@ exports.addSetsToSet = addSetsToSet;
 exports.arrayCopyTwoDimensional = arrayCopyTwoDimensional;
 exports.arrayEquals = arrayEquals;
 exports.arrayRemove = arrayRemove;
+exports.arrayRemoveAllInPlace = arrayRemoveAllInPlace;
 exports.arrayRemoveInPlace = arrayRemoveInPlace;
 exports.assertArray = assertArray;
 exports.assertBoolean = assertBoolean;
 exports.assertDefined = assertDefined;
 exports.assertEnumValue = assertEnumValue;
+exports.assertIs = assertIs;
 exports.assertNotNull = assertNotNull;
 exports.assertNumber = assertNumber;
 exports.assertObject = assertObject;

package/dist/index.mjs

@@ -54,6 +54,11 @@ function assertEnumValue(value, transpiledEnum, msg, set) {
     throw new TypeError(msg);
   }
 }
+function assertIs(value, constructor, msg) {
+  if (!(value instanceof constructor)) {
+    throw new TypeError(msg);
+  }
+}
 function assertNotNull(value, ...[msg]) {
   if (value === null) {
     throw new TypeError(msg);
@@ -118,6 +123,20 @@ function arrayRemove(originalArray, ...elementsToRemove) {
   }
   return array;
 }
+function arrayRemoveAllInPlace(array, ...elementsToRemove) {
+  let removedOneOrMoreElements = false;
+  for (const element of elementsToRemove) {
+    let index;
+    do {
+      index = array.indexOf(element);
+      if (index > -1) {
+        removedOneOrMoreElements = true;
+        array.splice(index, 1);
+      }
+    } while (index > -1);
+  }
+  return removedOneOrMoreElements;
+}
 function arrayRemoveInPlace(array, ...elementsToRemove) {
   const removedElements = [];
   for (const element of elementsToRemove) {
@@ -172,8 +191,8 @@ function includes(array, searchElement) {
 function includesAny(array, ...searchElements) {
   return searchElements.some((element) => array.includes(element));
 }
-function isArray(arg) {
-  return Array.isArray(arg);
+function isArray(variable) {
+  return Array.isArray(variable);
 }
 function newArray(length, value) {
   return Array.from({ length }, () => value);
@@ -511,4 +530,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, includesAny, interfaceSatisfiesEnum, isArray, isEnumValue, isFirstLetterCapitalized, isKebabCase, isKeyOf, isLowerCase, isObject, isSemanticVersion, isUpperCase, kebabCaseToCamelCase, kebabCaseToPascalCase, 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 };
+export { HOUR_IN_MILLISECONDS, MINUTE_IN_MILLISECONDS, ReadonlyMap, ReadonlySet, SECOND_IN_MILLISECONDS, addSetsToSet, arrayCopyTwoDimensional, arrayEquals, arrayRemove, arrayRemoveAllInPlace, arrayRemoveInPlace, assertArray, assertBoolean, assertDefined, assertEnumValue, assertIs, 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, includesAny, interfaceSatisfiesEnum, isArray, isEnumValue, isFirstLetterCapitalized, isKebabCase, isKeyOf, isLowerCase, isObject, isSemanticVersion, isUpperCase, kebabCaseToCamelCase, kebabCaseToPascalCase, 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/package.json

@@ -1,8 +1,7 @@
 {
   "name": "complete-common",
-  "version": "2.4.0",
+  "version": "2.6.0",
   "description": "Helper functions for TypeScript projects.",
-  "keywords": [],
   "homepage": "https://complete-ts.github.io/",
   "bugs": {
     "url": "https://github.com/complete-ts/complete/issues"
@@ -23,24 +22,20 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
-    "src",
-    "LICENSE",
-    "package.json",
-    "README.md"
+    "src"
   ],
   "scripts": {
     "build": "tsx ./scripts/build.ts",
     "docs": "typedoc",
     "lint": "tsx ./scripts/lint.ts",
-    "test": "glob \"./src/**/*.test.ts\" --cmd=\"node --import tsx --test --test-reporter spec\""
+    "test": "tsx --test"
   },
   "devDependencies": {
-    "@types/node": "24.0.14",
-    "complete-node": "7.4.0",
+    "@types/node": "24.7.1",
+    "complete-node": "12.2.0",
     "eslint-plugin-sort-exports": "0.9.1",
-    "glob": "11.0.3",
-    "typescript": "5.8.3",
-    "typescript-eslint": "8.37.0",
-    "unbuild": "3.5.0"
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.46.0",
+    "unbuild": "3.6.1"
   }
 }

package/src/functions/array.ts

@@ -48,6 +48,8 @@ export function arrayEquals<T>(
  * array. If the specified element(s) are not found in the array, it will simply return a shallow
  * copy of the array.
  *
+ * If there is more than one matching element in the array, this function will remove all of them.
+ *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
 export function arrayRemove<T>(
@@ -66,6 +68,39 @@ export function arrayRemove<T>(
   return array;
 }
 
+/**
+ * Removes all of the specified element(s) from the array. If the specified element(s) are not found
+ * in the array, this function will do nothing.
+ *
+ * This function is variadic, meaning that you can specify N arguments to remove N elements.
+ *
+ * If there is more than one matching element in the array, this function will remove every matching
+ * element. If you want to only remove the first matching element, use the `arrayRemoveInPlace`
+ * function instead.
+ *
+ * @returns True if one or more elements were removed, false otherwise.
+ */
+export function arrayRemoveAllInPlace<T>(
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
+  array: T[],
+  ...elementsToRemove: readonly T[]
+): boolean {
+  let removedOneOrMoreElements = false;
+
+  for (const element of elementsToRemove) {
+    let index: number;
+    do {
+      index = array.indexOf(element);
+      if (index > -1) {
+        removedOneOrMoreElements = true;
+        array.splice(index, 1);
+      }
+    } while (index > -1);
+  }
+
+  return removedOneOrMoreElements;
+}
+
 /**
  * Removes the specified element(s) from the array. If the specified element(s) are not found in the
  * array, this function will do nothing.
@@ -73,8 +108,7 @@ export function arrayRemove<T>(
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  *
  * If there is more than one matching element in the array, this function will only remove the first
- * matching element. If you want to remove all of the elements, use the `arrayRemoveAllInPlace`
- * function instead.
+ * one. If you want to remove all of the elements, use the `arrayRemoveAllInPlace` function instead.
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
@@ -207,8 +241,8 @@ export function includesAny<T>(
 }
 
 /** A wrapper around `Array.isArray` that narrows to `unknown[]` instead of `any[]`. */
-export function isArray(arg: unknown): arg is unknown[] {
-  return Array.isArray(arg);
+export function isArray(variable: unknown): variable is unknown[] {
+  return Array.isArray(variable);
 }
 
 /** Initializes an array with all elements containing the specified default value. */

package/src/functions/assert.ts

@@ -67,6 +67,23 @@ export function assertEnumValue<T extends TranspiledEnum>(
   }
 }
 
+/**
+ * Helper function to throw an error if the provided value is not an instance of the expected class.
+ *
+ * This is useful to have TypeScript narrow a value to a specific type in a concise way.
+ */
+export function assertIs<
+  T extends abstract new (...args: unknown[]) => unknown,
+>(
+  value: unknown,
+  constructor: T,
+  msg: string,
+): asserts value is InstanceType<T> {
+  if (!(value instanceof constructor)) {
+    throw new TypeError(msg);
+  }
+}
+
 /**
  * Helper function to throw an error if the provided value is equal to `null`.
  *

package/src/functions/string.test.ts

@@ -1,5 +1,5 @@
 import { equal } from "node:assert";
-import test, { describe } from "node:test";
+import { describe, test } from "node:test";
 import {
   hasDiacritic,
   hasEmoji,

package/src/functions/string.ts

@@ -227,6 +227,7 @@ export function parseSemanticVersion(versionString: string):
   return { majorVersion, minorVersion, patchVersion };
 }
 
+/* eslint-disable jsdoc/escape-inline-tags */
 /**
  * Helper function to remove lines from a multi-line string. This function looks for a "-start" and
  * a "-end" suffix after the marker. Lines with markets will be completely removed from the output.
@@ -249,6 +250,7 @@ export function parseSemanticVersion(versionString: string):
  * line4
  * ```
  */
+/* eslint-enable jsdoc/escape-inline-tags */
 export function removeLinesBetweenMarkers(
   string: string,
   marker: string,

package/src/functions/utils.test.ts

@@ -1,5 +1,5 @@
 import { deepStrictEqual, strictEqual } from "node:assert";
-import test, { describe } from "node:test";
+import { describe, test } from "node:test";
 import { assertDefined, assertNotNull } from "./assert.js";
 import { eRange, iRange, parseFloatSafe, parseIntSafe } from "./utils.js";
 
@@ -372,7 +372,7 @@ describe("parseFloatSafe", () => {
     });
 
     test("bigint", () => {
-      const result = parseFloatSafe(BigInt(1) as unknown as string);
+      const result = parseFloatSafe(1n as unknown as string);
       strictEqual(result, undefined);
     });
 
@@ -693,7 +693,7 @@ describe("parseIntSafe", () => {
     });
 
     test("bigint", () => {
-      const result = parseIntSafe(BigInt(1) as unknown as string);
+      const result = parseIntSafe(1n as unknown as string);
       strictEqual(result, undefined);
     });