complete-common 2.9.0 → 2.11.0

package/README.md

@@ -2,6 +2,6 @@
 
 [![npm version](https://img.shields.io/npm/v/complete-common.svg)](https://www.npmjs.com/package/complete-common)
 
-This package contains helper functions for a typical [TypeScript](https://www.typescriptlang.org/) project, such as [`iRange`](/complete-common/functions/utils#irange).
+`complete-common` is a library that contains basic helper functions for a typical [TypeScript](https://www.typescriptlang.org/) project, such as [`iRange`](/complete-common/functions/utils#irange).
 
 Please see the [docs](https://complete-ts.github.io/complete-common) for more information.

package/dist/functions/assert.d.cts

@@ -16,6 +16,11 @@ export declare function assertArrayBoolean(value: unknown, msg: string): asserts
  * a number.
  */
 export declare function assertArrayNumber(value: unknown, msg: string): asserts value is unknown[];
+/**
+ * Helper function to throw an error if the provided value is not an array with every element being
+ * an object (i.e. a TypeScript record).
+ */
+export declare function assertArrayObject(value: unknown, msg: string): asserts value is Array<Record<string, unknown>>;
 /**
  * Helper function to throw an error if the provided value is not an array with every element being
  * a string.
@@ -72,4 +77,6 @@ export declare function assertNumber(value: unknown, msg: string): asserts value
 export declare function assertObject(value: unknown, msg: string): asserts value is Record<string, unknown>;
 /** Helper function to throw an error if the provided value is not a string. */
 export declare function assertString(value: unknown, msg: string): asserts value is string;
+/** Helper function to throw an error if the provided value is not a string or an empty string. */
+export declare function assertStringNotEmpty(value: unknown, msg: string): asserts value is string;
 //# sourceMappingURL=assert.d.ts.map

package/dist/functions/assert.d.mts

@@ -16,6 +16,11 @@ export declare function assertArrayBoolean(value: unknown, msg: string): asserts
  * a number.
  */
 export declare function assertArrayNumber(value: unknown, msg: string): asserts value is unknown[];
+/**
+ * Helper function to throw an error if the provided value is not an array with every element being
+ * an object (i.e. a TypeScript record).
+ */
+export declare function assertArrayObject(value: unknown, msg: string): asserts value is Array<Record<string, unknown>>;
 /**
  * Helper function to throw an error if the provided value is not an array with every element being
  * a string.
@@ -72,4 +77,6 @@ export declare function assertNumber(value: unknown, msg: string): asserts value
 export declare function assertObject(value: unknown, msg: string): asserts value is Record<string, unknown>;
 /** Helper function to throw an error if the provided value is not a string. */
 export declare function assertString(value: unknown, msg: string): asserts value is string;
+/** Helper function to throw an error if the provided value is not a string or an empty string. */
+export declare function assertStringNotEmpty(value: unknown, msg: string): asserts value is string;
 //# sourceMappingURL=assert.d.ts.map

package/dist/functions/assert.d.ts

@@ -16,6 +16,11 @@ export declare function assertArrayBoolean(value: unknown, msg: string): asserts
  * a number.
  */
 export declare function assertArrayNumber(value: unknown, msg: string): asserts value is unknown[];
+/**
+ * Helper function to throw an error if the provided value is not an array with every element being
+ * an object (i.e. a TypeScript record).
+ */
+export declare function assertArrayObject(value: unknown, msg: string): asserts value is Array<Record<string, unknown>>;
 /**
  * Helper function to throw an error if the provided value is not an array with every element being
  * a string.
@@ -72,4 +77,6 @@ export declare function assertNumber(value: unknown, msg: string): asserts value
 export declare function assertObject(value: unknown, msg: string): asserts value is Record<string, unknown>;
 /** Helper function to throw an error if the provided value is not a string. */
 export declare function assertString(value: unknown, msg: string): asserts value is string;
+/** Helper function to throw an error if the provided value is not a string or an empty string. */
+export declare function assertStringNotEmpty(value: unknown, msg: string): asserts value is string;
 //# sourceMappingURL=assert.d.ts.map

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;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,OAAO,EAAE,CAM5B;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,OAAO,EAAE,CAM5B;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,OAAO,EAAE,CAM5B;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,iFAAiF;AACjF,wBAAgB,aAAa,CAC3B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,MAAM,CAMzB;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"}
+{"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;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,OAAO,EAAE,CAM5B;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,OAAO,EAAE,CAM5B;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAMjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,OAAO,EAAE,CAM5B;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,iFAAiF;AACjF,wBAAgB,aAAa,CAC3B,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,MAAM,CAMzB;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;AAED,kGAAkG;AAClG,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,MAAM,CAMzB"}

package/dist/functions/utils.d.cts

@@ -33,8 +33,8 @@
  */
 export declare function eRange(start: number, end?: number, increment?: number): Generator<number>;
 /**
- * Helper function to get an array of integers with the specified range, inclusive on both ends.
- * (The "i" in the function name stands for inclusive.)
+ * Helper function to get an iterator of of integers with the specified range, inclusive on both
+ * ends. (The "i" in the function name stands for inclusive.)
  *
  * If the end is lower than the start, then an empty range will be returned.
  *

package/dist/functions/utils.d.mts

@@ -33,8 +33,8 @@
  */
 export declare function eRange(start: number, end?: number, increment?: number): Generator<number>;
 /**
- * Helper function to get an array of integers with the specified range, inclusive on both ends.
- * (The "i" in the function name stands for inclusive.)
+ * Helper function to get an iterator of of integers with the specified range, inclusive on both
+ * ends. (The "i" in the function name stands for inclusive.)
  *
  * If the end is lower than the start, then an empty range will be returned.
  *

package/dist/functions/utils.d.ts

@@ -33,8 +33,8 @@
  */
 export declare function eRange(start: number, end?: number, increment?: number): Generator<number>;
 /**
- * Helper function to get an array of integers with the specified range, inclusive on both ends.
- * (The "i" in the function name stands for inclusive.)
+ * Helper function to get an iterator of of integers with the specified range, inclusive on both
+ * ends. (The "i" in the function name stands for inclusive.)
  *
  * If the end is lower than the start, then an empty range will be returned.
  *

package/dist/index.cjs

@@ -53,6 +53,12 @@ function assertArrayNumber(value, msg) {
     throw new TypeError(msg);
   }
 }
+function assertArrayObject(value, msg) {
+  assertArray(value, msg);
+  if (value.some((element) => !isObject(element))) {
+    throw new TypeError(msg);
+  }
+}
 function assertArrayString(value, msg) {
   assertArray(value, msg);
   if (value.some((element) => typeof element !== "string")) {
@@ -104,6 +110,12 @@ function assertString(value, msg) {
     throw new TypeError(msg);
   }
 }
+function assertStringNotEmpty(value, msg) {
+  assertString(value, msg);
+  if (value === "") {
+    throw new TypeError(msg);
+  }
+}
 
 function getRandomInt(min, max, exceptions = []) {
   min = Math.ceil(min);
@@ -590,6 +602,7 @@ exports.arrayRemoveInPlace = arrayRemoveInPlace;
 exports.assertArray = assertArray;
 exports.assertArrayBoolean = assertArrayBoolean;
 exports.assertArrayNumber = assertArrayNumber;
+exports.assertArrayObject = assertArrayObject;
 exports.assertArrayString = assertArrayString;
 exports.assertBoolean = assertBoolean;
 exports.assertDefined = assertDefined;
@@ -600,6 +613,7 @@ exports.assertNotNull = assertNotNull;
 exports.assertNumber = assertNumber;
 exports.assertObject = assertObject;
 exports.assertString = assertString;
+exports.assertStringNotEmpty = assertStringNotEmpty;
 exports.capitalizeFirstLetter = capitalizeFirstLetter;
 exports.clamp = clamp;
 exports.combineSets = combineSets;

package/dist/index.mjs

@@ -51,6 +51,12 @@ function assertArrayNumber(value, msg) {
     throw new TypeError(msg);
   }
 }
+function assertArrayObject(value, msg) {
+  assertArray(value, msg);
+  if (value.some((element) => !isObject(element))) {
+    throw new TypeError(msg);
+  }
+}
 function assertArrayString(value, msg) {
   assertArray(value, msg);
   if (value.some((element) => typeof element !== "string")) {
@@ -102,6 +108,12 @@ function assertString(value, msg) {
     throw new TypeError(msg);
   }
 }
+function assertStringNotEmpty(value, msg) {
+  assertString(value, msg);
+  if (value === "") {
+    throw new TypeError(msg);
+  }
+}
 
 function getRandomInt(min, max, exceptions = []) {
   min = Math.ceil(min);
@@ -574,4 +586,4 @@ function* tupleKeys(tuple) {
 
 const ReadonlyMap = Map;
 
-export { HOUR_IN_MILLISECONDS, MINUTE_IN_MILLISECONDS, ReadonlyMap, ReadonlySet, SECOND_IN_MILLISECONDS, addSetsToSet, arrayCopyTwoDimensional, arrayEquals, arrayRemove, arrayRemoveAllInPlace, arrayRemoveInPlace, assertArray, assertArrayBoolean, assertArrayNumber, assertArrayString, assertBoolean, assertDefined, assertEnumValue, assertInteger, 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, isASCII, isArray, isArrayBoolean, isArrayNumber, isArrayString, 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, assertArrayBoolean, assertArrayNumber, assertArrayObject, assertArrayString, assertBoolean, assertDefined, assertEnumValue, assertInteger, assertIs, assertNotNull, assertNumber, assertObject, assertString, assertStringNotEmpty, capitalizeFirstLetter, clamp, combineSets, copySet, eRange, emptyArray, escapeHTMLCharacters, filterMap, getElapsedSeconds, getEnumEntries, getEnumKeys, getEnumValues, getNumConsecutiveDiacritics, getRandomArrayElement, getRandomArrayIndex, getRandomInt, hasDiacritic, hasEmoji, hasWhitespace, iRange, includes, includesAny, interfaceSatisfiesEnum, isASCII, isArray, isArrayBoolean, isArrayNumber, isArrayString, 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,6 +1,6 @@
 {
   "name": "complete-common",
-  "version": "2.9.0",
+  "version": "2.11.0",
   "description": "Helper functions for TypeScript projects.",
   "homepage": "https://complete-ts.github.io/",
   "bugs": {
@@ -31,11 +31,11 @@
     "test": "tsx --test"
   },
   "devDependencies": {
-    "@types/node": "24.9.1",
-    "complete-node": "12.2.1",
+    "@types/node": "24.10.2",
+    "complete-node": "13.0.0",
     "eslint-plugin-sort-exports": "0.9.1",
     "typescript": "5.9.3",
-    "typescript-eslint": "8.46.2",
+    "typescript-eslint": "8.49.0",
     "unbuild": "3.6.1"
   }
 }

package/src/functions/assert.ts

@@ -48,6 +48,21 @@ export function assertArrayNumber(
   }
 }
 
+/**
+ * Helper function to throw an error if the provided value is not an array with every element being
+ * an object (i.e. a TypeScript record).
+ */
+export function assertArrayObject(
+  value: unknown,
+  msg: string,
+): asserts value is Array<Record<string, unknown>> {
+  assertArray(value, msg);
+
+  if (value.some((element) => !isObject(element))) {
+    throw new TypeError(msg);
+  }
+}
+
 /**
  * Helper function to throw an error if the provided value is not an array with every element being
  * a string.
@@ -196,3 +211,15 @@ export function assertString(
     throw new TypeError(msg);
   }
 }
+
+/** Helper function to throw an error if the provided value is not a string or an empty string. */
+export function assertStringNotEmpty(
+  value: unknown,
+  msg: string,
+): asserts value is string {
+  assertString(value, msg);
+
+  if (value === "") {
+    throw new TypeError(msg);
+  }
+}

package/src/functions/utils.ts

@@ -54,8 +54,8 @@ export function* eRange(
 }
 
 /**
- * Helper function to get an array of integers with the specified range, inclusive on both ends.
- * (The "i" in the function name stands for inclusive.)
+ * Helper function to get an iterator of of integers with the specified range, inclusive on both
+ * ends. (The "i" in the function name stands for inclusive.)
  *
  * If the end is lower than the start, then an empty range will be returned.
  *