complete-common 1.1.2 → 1.3.0

package/dist/functions/assert.d.cts

@@ -3,16 +3,10 @@
  *
  * @module
  */
-declare const TYPES_TO_VALIDATION_FUNCTIONS: {
-    readonly string: (val: unknown) => val is string;
-    readonly number: (val: unknown) => val is number;
-    readonly boolean: (val: unknown) => val is boolean;
-    readonly object: (val: unknown) => val is object;
-    readonly array: (val: unknown) => val is unknown[];
-    readonly null: (val: unknown) => val is null;
-    readonly undefined: (val: unknown) => val is undefined;
-    readonly function: (val: unknown) => val is Function;
-};
+/** 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. */
+export declare function assertBoolean(value: unknown, msg: string): asserts value is boolean;
 /**
  * Helper function to throw an error if the provided value is equal to `undefined`.
  *
@@ -29,6 +23,8 @@ export declare function assertDefined<T>(value: T, ...[msg]: [undefined] extends
 export declare function assertNotNull<T>(value: T, ...[msg]: [null] extends [T] ? [string] : [
     "The assertion is useless because the provided value does not contain null."
 ]): asserts value is Exclude<T, null>;
+/** Helper function to throw an error if the provided value is not a number. */
+export declare function assertNumber(value: unknown, msg: string): asserts value is number;
 /**
  * Helper function to throw an error if the provided value is not an object (i.e. a TypeScript
  * record).
@@ -39,7 +35,6 @@ export declare function assertNotNull<T>(value: T, ...[msg]: [null] extends [T]
  * Under the hood, this function uses the `isObject` helper function.
  */
 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 of the provided type. */
-export declare function assertType(value: unknown, type: keyof typeof TYPES_TO_VALIDATION_FUNCTIONS, msg: string): asserts value is unknown;
-export {};
+/** 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;
 //# sourceMappingURL=assert.d.ts.map

package/dist/functions/assert.d.mts

@@ -3,16 +3,10 @@
  *
  * @module
  */
-declare const TYPES_TO_VALIDATION_FUNCTIONS: {
-    readonly string: (val: unknown) => val is string;
-    readonly number: (val: unknown) => val is number;
-    readonly boolean: (val: unknown) => val is boolean;
-    readonly object: (val: unknown) => val is object;
-    readonly array: (val: unknown) => val is unknown[];
-    readonly null: (val: unknown) => val is null;
-    readonly undefined: (val: unknown) => val is undefined;
-    readonly function: (val: unknown) => val is Function;
-};
+/** 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. */
+export declare function assertBoolean(value: unknown, msg: string): asserts value is boolean;
 /**
  * Helper function to throw an error if the provided value is equal to `undefined`.
  *
@@ -29,6 +23,8 @@ export declare function assertDefined<T>(value: T, ...[msg]: [undefined] extends
 export declare function assertNotNull<T>(value: T, ...[msg]: [null] extends [T] ? [string] : [
     "The assertion is useless because the provided value does not contain null."
 ]): asserts value is Exclude<T, null>;
+/** Helper function to throw an error if the provided value is not a number. */
+export declare function assertNumber(value: unknown, msg: string): asserts value is number;
 /**
  * Helper function to throw an error if the provided value is not an object (i.e. a TypeScript
  * record).
@@ -39,7 +35,6 @@ export declare function assertNotNull<T>(value: T, ...[msg]: [null] extends [T]
  * Under the hood, this function uses the `isObject` helper function.
  */
 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 of the provided type. */
-export declare function assertType(value: unknown, type: keyof typeof TYPES_TO_VALIDATION_FUNCTIONS, msg: string): asserts value is unknown;
-export {};
+/** 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;
 //# sourceMappingURL=assert.d.ts.map

package/dist/functions/assert.d.ts

@@ -3,16 +3,10 @@
  *
  * @module
  */
-declare const TYPES_TO_VALIDATION_FUNCTIONS: {
-    readonly string: (val: unknown) => val is string;
-    readonly number: (val: unknown) => val is number;
-    readonly boolean: (val: unknown) => val is boolean;
-    readonly object: (val: unknown) => val is object;
-    readonly array: (val: unknown) => val is unknown[];
-    readonly null: (val: unknown) => val is null;
-    readonly undefined: (val: unknown) => val is undefined;
-    readonly function: (val: unknown) => val is Function;
-};
+/** 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. */
+export declare function assertBoolean(value: unknown, msg: string): asserts value is boolean;
 /**
  * Helper function to throw an error if the provided value is equal to `undefined`.
  *
@@ -29,6 +23,8 @@ export declare function assertDefined<T>(value: T, ...[msg]: [undefined] extends
 export declare function assertNotNull<T>(value: T, ...[msg]: [null] extends [T] ? [string] : [
     "The assertion is useless because the provided value does not contain null."
 ]): asserts value is Exclude<T, null>;
+/** Helper function to throw an error if the provided value is not a number. */
+export declare function assertNumber(value: unknown, msg: string): asserts value is number;
 /**
  * Helper function to throw an error if the provided value is not an object (i.e. a TypeScript
  * record).
@@ -39,7 +35,6 @@ export declare function assertNotNull<T>(value: T, ...[msg]: [null] extends [T]
  * Under the hood, this function uses the `isObject` helper function.
  */
 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 of the provided type. */
-export declare function assertType(value: unknown, type: keyof typeof TYPES_TO_VALIDATION_FUNCTIONS, msg: string): asserts value is unknown;
-export {};
+/** 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;
 //# 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;AAIH,QAAA,MAAM,6BAA6B;2BACnB,OAAO,KAAG,GAAG,IAAI,MAAM;2BACvB,OAAO,KAAG,GAAG,IAAI,MAAM;4BACtB,OAAO,KAAG,GAAG,IAAI,OAAO;2BACzB,OAAO,KAAG,GAAG,IAAI,MAAM;0BAExB,OAAO,KAAG,GAAG,IAAI,OAAO,EAAE;yBAC3B,OAAO,KAAG,GAAG,IAAI,IAAI;8BAChB,OAAO,KAAG,GAAG,IAAI,SAAS;6BAE3B,OAAO,KAAG,GAAG,IAAI,QAAQ;CACjC,CAAC;AAEX;;;;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;;;;;;;;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,2FAA2F;AAC3F,wBAAgB,UAAU,CACxB,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,MAAM,OAAO,6BAA6B,EAChD,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,OAAO,CAK1B"}
+{"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"}

package/dist/index.cjs

@@ -10,17 +10,16 @@ function isObject(variable) {
   return typeof variable === "object" && variable !== null && !Array.isArray(variable);
 }
 
-const TYPES_TO_VALIDATION_FUNCTIONS = {
-  string: (val) => typeof val === "string",
-  number: (val) => typeof val === "number",
-  boolean: (val) => typeof val === "boolean",
-  object: (val) => val !== null && typeof val === "object",
-  array: (val) => Array.isArray(val),
-  null: (val) => val === null,
-  undefined: (val) => val === void 0,
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
-  function: (val) => typeof val === "function"
-};
+function assertArray(value, msg) {
+  if (!Array.isArray(value)) {
+    throw new TypeError(msg);
+  }
+}
+function assertBoolean(value, msg) {
+  if (typeof value !== "boolean") {
+    throw new TypeError(msg);
+  }
+}
 function assertDefined(value, ...[msg]) {
   if (value === void 0) {
     throw new TypeError(msg);
@@ -31,14 +30,18 @@ function assertNotNull(value, ...[msg]) {
     throw new TypeError(msg);
   }
 }
+function assertNumber(value, msg) {
+  if (typeof value !== "number") {
+    throw new TypeError(msg);
+  }
+}
 function assertObject(value, msg) {
   if (!isObject(value)) {
     throw new TypeError(msg);
   }
 }
-function assertType(value, type, msg) {
-  const validationFunction = TYPES_TO_VALIDATION_FUNCTIONS[type];
-  if (!validationFunction(value)) {
+function assertString(value, msg) {
+  if (typeof value !== "string") {
     throw new TypeError(msg);
   }
 }
@@ -512,10 +515,13 @@ exports.arrayCopyTwoDimensional = arrayCopyTwoDimensional;
 exports.arrayEquals = arrayEquals;
 exports.arrayRemove = arrayRemove;
 exports.arrayRemoveInPlace = arrayRemoveInPlace;
+exports.assertArray = assertArray;
+exports.assertBoolean = assertBoolean;
 exports.assertDefined = assertDefined;
 exports.assertNotNull = assertNotNull;
+exports.assertNumber = assertNumber;
 exports.assertObject = assertObject;
-exports.assertType = assertType;
+exports.assertString = assertString;
 exports.capitalizeFirstLetter = capitalizeFirstLetter;
 exports.clamp = clamp;
 exports.combineSets = combineSets;

package/dist/index.mjs

@@ -8,17 +8,16 @@ function isObject(variable) {
   return typeof variable === "object" && variable !== null && !Array.isArray(variable);
 }
 
-const TYPES_TO_VALIDATION_FUNCTIONS = {
-  string: (val) => typeof val === "string",
-  number: (val) => typeof val === "number",
-  boolean: (val) => typeof val === "boolean",
-  object: (val) => val !== null && typeof val === "object",
-  array: (val) => Array.isArray(val),
-  null: (val) => val === null,
-  undefined: (val) => val === void 0,
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
-  function: (val) => typeof val === "function"
-};
+function assertArray(value, msg) {
+  if (!Array.isArray(value)) {
+    throw new TypeError(msg);
+  }
+}
+function assertBoolean(value, msg) {
+  if (typeof value !== "boolean") {
+    throw new TypeError(msg);
+  }
+}
 function assertDefined(value, ...[msg]) {
   if (value === void 0) {
     throw new TypeError(msg);
@@ -29,14 +28,18 @@ function assertNotNull(value, ...[msg]) {
     throw new TypeError(msg);
   }
 }
+function assertNumber(value, msg) {
+  if (typeof value !== "number") {
+    throw new TypeError(msg);
+  }
+}
 function assertObject(value, msg) {
   if (!isObject(value)) {
     throw new TypeError(msg);
   }
 }
-function assertType(value, type, msg) {
-  const validationFunction = TYPES_TO_VALIDATION_FUNCTIONS[type];
-  if (!validationFunction(value)) {
+function assertString(value, msg) {
+  if (typeof value !== "string") {
     throw new TypeError(msg);
   }
 }
@@ -500,4 +503,4 @@ function* tupleKeys(tuple) {
 
 const ReadonlyMap = Map;
 
-export { HOUR_IN_MILLISECONDS, MINUTE_IN_MILLISECONDS, ReadonlyMap, ReadonlySet, SECOND_IN_MILLISECONDS, addSetsToSet, arrayCopyTwoDimensional, arrayEquals, arrayRemove, arrayRemoveInPlace, assertDefined, assertNotNull, assertObject, assertType, 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, 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.1.2",
+  "version": "1.3.0",
   "description": "Helper functions for TypeScript projects.",
   "keywords": [],
   "homepage": "https://complete-ts.github.io/",
@@ -36,11 +36,11 @@
   },
   "devDependencies": {
     "@types/node": "22.13.5",
-    "complete-node": "3.1.1",
+    "complete-node": "3.1.6",
     "eslint-plugin-sort-exports": "0.9.1",
     "glob": "11.0.1",
     "typescript": "5.7.3",
     "typescript-eslint": "8.25.0",
-    "unbuild": "3.3.1"
+    "unbuild": "3.5.0"
   }
 }

package/src/functions/assert.ts

@@ -6,18 +6,25 @@
 
 import { isObject } from "./types.js";
 
-const TYPES_TO_VALIDATION_FUNCTIONS = {
-  string: (val: unknown): val is string => typeof val === "string",
-  number: (val: unknown): val is number => typeof val === "number",
-  boolean: (val: unknown): val is boolean => typeof val === "boolean",
-  object: (val: unknown): val is object =>
-    val !== null && typeof val === "object",
-  array: (val: unknown): val is unknown[] => Array.isArray(val),
-  null: (val: unknown): val is null => val === null,
-  undefined: (val: unknown): val is undefined => val === undefined,
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
-  function: (val: unknown): val is Function => typeof val === "function",
-} as const;
+/** Helper function to throw an error if the provided value is not an array. */
+export function assertArray(
+  value: unknown,
+  msg: string,
+): asserts value is unknown[] {
+  if (!Array.isArray(value)) {
+    throw new TypeError(msg);
+  }
+}
+
+/** Helper function to throw an error if the provided value is not a boolean. */
+export function assertBoolean(
+  value: unknown,
+  msg: string,
+): asserts value is boolean {
+  if (typeof value !== "boolean") {
+    throw new TypeError(msg);
+  }
+}
 
 /**
  * Helper function to throw an error if the provided value is equal to `undefined`.
@@ -55,6 +62,16 @@ export function assertNotNull<T>(
   }
 }
 
+/** Helper function to throw an error if the provided value is not a number. */
+export function assertNumber(
+  value: unknown,
+  msg: string,
+): asserts value is number {
+  if (typeof value !== "number") {
+    throw new TypeError(msg);
+  }
+}
+
 /**
  * Helper function to throw an error if the provided value is not an object (i.e. a TypeScript
  * record).
@@ -73,14 +90,12 @@ export function assertObject(
   }
 }
 
-/** Helper function to throw an error if the provided value is not of the provided type. */
-export function assertType(
+/** Helper function to throw an error if the provided value is not a string. */
+export function assertString(
   value: unknown,
-  type: keyof typeof TYPES_TO_VALIDATION_FUNCTIONS,
   msg: string,
-): asserts value is unknown {
-  const validationFunction = TYPES_TO_VALIDATION_FUNCTIONS[type];
-  if (!validationFunction(value)) {
+): asserts value is string {
+  if (typeof value !== "string") {
     throw new TypeError(msg);
   }
 }

package/src/functions/string.ts

@@ -199,9 +199,9 @@ export function parseSemanticVersion(versionString: string):
   const patchVersion = parseIntSafe(patch);
 
   if (
-    majorVersion === undefined ||
-    minorVersion === undefined ||
-    patchVersion === undefined
+    majorVersion === undefined
+    || minorVersion === undefined
+    || patchVersion === undefined
   ) {
     return undefined;
   }

package/src/functions/types.ts

@@ -14,8 +14,8 @@ export function isObject(
   variable: unknown,
 ): variable is Record<string, unknown> {
   return (
-    typeof variable === "object" &&
-    variable !== null &&
-    !Array.isArray(variable)
+    typeof variable === "object"
+    && variable !== null
+    && !Array.isArray(variable)
   );
 }