complete-common 1.0.1 → 1.1.1

package/dist/functions/assert.d.cts

@@ -3,6 +3,16 @@
  *
  * @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 equal to `undefined`.
  *
@@ -19,4 +29,17 @@ 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 an object (i.e. a TypeScript
+ * record).
+ *
+ * This is useful to have TypeScript narrow a `Record<string, unknown> | undefined` value to
+ * `Record<string, unknown>` in a concise way.
+ *
+ * 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 {};
 //# sourceMappingURL=assert.d.ts.map

package/dist/functions/assert.d.mts

@@ -3,6 +3,16 @@
  *
  * @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 equal to `undefined`.
  *
@@ -19,4 +29,17 @@ 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 an object (i.e. a TypeScript
+ * record).
+ *
+ * This is useful to have TypeScript narrow a `Record<string, unknown> | undefined` value to
+ * `Record<string, unknown>` in a concise way.
+ *
+ * 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 {};
 //# sourceMappingURL=assert.d.ts.map

package/dist/functions/assert.d.ts

@@ -3,6 +3,16 @@
  *
  * @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 equal to `undefined`.
  *
@@ -19,4 +29,17 @@ 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 an object (i.e. a TypeScript
+ * record).
+ *
+ * This is useful to have TypeScript narrow a `Record<string, unknown> | undefined` value to
+ * `Record<string, unknown>` in a concise way.
+ *
+ * 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 {};
 //# 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;;;;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"}
+{"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"}

package/dist/functions/map.d.cts

@@ -21,32 +21,4 @@ export declare function mapFilter<K, V>(map: ReadonlyMap<K, V>, predicate: (valu
  * This is efficient such that it avoids converting the map values into an array.
  */
 export declare function mapFind<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): V | undefined;
-/**
- * Helper function to convert an object to a map.
- *
- * This is useful when you need to construct a type safe object with the `satisfies` operator, but
- * then later on you need to query it in a way where you expect the return value to be T or
- * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
- * assertions.
- *
- * Note that the map values will be inserted in a random order, due to how `pairs` works under the
- * hood.
- *
- * Also see the `objectToReadonlyMap` function.
- */
-export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): Map<K, V>;
-/**
- * Helper function to convert an object to a read-only map.
- *
- * This is useful when you need to construct a type safe object with the `satisfies` operator, but
- * then later on you need to query it in a way where you expect the return value to be T or
- * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
- * assertions.
- *
- * Note that the map values will be inserted in a random order, due to how `pairs` works under the
- * hood.
- *
- * Also see the `objectToMap` function.
- */
-export declare function objectToReadonlyMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
 //# sourceMappingURL=map.d.ts.map

package/dist/functions/map.d.mts

@@ -21,32 +21,4 @@ export declare function mapFilter<K, V>(map: ReadonlyMap<K, V>, predicate: (valu
  * This is efficient such that it avoids converting the map values into an array.
  */
 export declare function mapFind<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): V | undefined;
-/**
- * Helper function to convert an object to a map.
- *
- * This is useful when you need to construct a type safe object with the `satisfies` operator, but
- * then later on you need to query it in a way where you expect the return value to be T or
- * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
- * assertions.
- *
- * Note that the map values will be inserted in a random order, due to how `pairs` works under the
- * hood.
- *
- * Also see the `objectToReadonlyMap` function.
- */
-export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): Map<K, V>;
-/**
- * Helper function to convert an object to a read-only map.
- *
- * This is useful when you need to construct a type safe object with the `satisfies` operator, but
- * then later on you need to query it in a way where you expect the return value to be T or
- * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
- * assertions.
- *
- * Note that the map values will be inserted in a random order, due to how `pairs` works under the
- * hood.
- *
- * Also see the `objectToMap` function.
- */
-export declare function objectToReadonlyMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
 //# sourceMappingURL=map.d.ts.map

package/dist/functions/map.d.ts

@@ -21,32 +21,4 @@ export declare function mapFilter<K, V>(map: ReadonlyMap<K, V>, predicate: (valu
  * This is efficient such that it avoids converting the map values into an array.
  */
 export declare function mapFind<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): V | undefined;
-/**
- * Helper function to convert an object to a map.
- *
- * This is useful when you need to construct a type safe object with the `satisfies` operator, but
- * then later on you need to query it in a way where you expect the return value to be T or
- * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
- * assertions.
- *
- * Note that the map values will be inserted in a random order, due to how `pairs` works under the
- * hood.
- *
- * Also see the `objectToReadonlyMap` function.
- */
-export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): Map<K, V>;
-/**
- * Helper function to convert an object to a read-only map.
- *
- * This is useful when you need to construct a type safe object with the `satisfies` operator, but
- * then later on you need to query it in a way where you expect the return value to be T or
- * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
- * assertions.
- *
- * Note that the map values will be inserted in a random order, due to how `pairs` works under the
- * hood.
- *
- * Also see the `objectToMap` function.
- */
-export declare function objectToReadonlyMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
 //# sourceMappingURL=map.d.ts.map

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

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

package/dist/functions/object.d.cts

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

package/dist/functions/object.d.mts

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

package/dist/functions/object.d.ts

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

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

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

package/dist/functions/time.d.cts

@@ -0,0 +1,20 @@
+/**
+ * Helper functions having to do with time.
+ *
+ * @module
+ */
+/**
+ * Helper function to get the number of elapsed seconds since a starting time.
+ *
+ * This function always returns a whole number (using `Math.floor` on the result).
+ *
+ * For example:
+ *
+ * ```ts
+ * const startTime = Date.now();
+ * doSomething();
+ * const elapsedSeconds = getElapsedSeconds(startTime);
+ * ```
+ */
+export declare function getElapsedSeconds(startTime: number): number;
+//# sourceMappingURL=time.d.ts.map

package/dist/functions/time.d.mts

@@ -0,0 +1,20 @@
+/**
+ * Helper functions having to do with time.
+ *
+ * @module
+ */
+/**
+ * Helper function to get the number of elapsed seconds since a starting time.
+ *
+ * This function always returns a whole number (using `Math.floor` on the result).
+ *
+ * For example:
+ *
+ * ```ts
+ * const startTime = Date.now();
+ * doSomething();
+ * const elapsedSeconds = getElapsedSeconds(startTime);
+ * ```
+ */
+export declare function getElapsedSeconds(startTime: number): number;
+//# sourceMappingURL=time.d.ts.map

package/dist/functions/time.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Helper functions having to do with time.
+ *
+ * @module
+ */
+/**
+ * Helper function to get the number of elapsed seconds since a starting time.
+ *
+ * This function always returns a whole number (using `Math.floor` on the result).
+ *
+ * For example:
+ *
+ * ```ts
+ * const startTime = Date.now();
+ * doSomething();
+ * const elapsedSeconds = getElapsedSeconds(startTime);
+ * ```
+ */
+export declare function getElapsedSeconds(startTime: number): number;
+//# sourceMappingURL=time.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"time.d.ts","sourceRoot":"","sources":["../../src/functions/time.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAM3D"}

package/dist/index.cjs

@@ -6,6 +6,21 @@ const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;
 
 const ReadonlySet = Set;
 
+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 assertDefined(value, ...[msg]) {
   if (value === void 0) {
     throw new TypeError(msg);
@@ -16,6 +31,17 @@ function assertNotNull(value, ...[msg]) {
     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)) {
+    throw new TypeError(msg);
+  }
+}
 
 function getRandomInt(min, max, exceptions = []) {
   min = Math.ceil(min);
@@ -166,16 +192,6 @@ function mapFind(map, predicate) {
   }
   return void 0;
 }
-function objectToMap(object) {
-  const map = /* @__PURE__ */ new Map();
-  for (const [key, value] of Object.entries(object)) {
-    map.set(key, value);
-  }
-  return map;
-}
-function objectToReadonlyMap(object) {
-  return objectToMap(object);
-}
 
 function clamp(num, min, max) {
   return Math.max(min, Math.min(num, max));
@@ -192,6 +208,26 @@ function objectFilter(object, predicate) {
   }
   return array;
 }
+function objectToMap(object) {
+  const map = /* @__PURE__ */ new Map();
+  for (const [key, value] of Object.entries(object)) {
+    map.set(key, value);
+  }
+  return map;
+}
+function objectToReadonlyMap(object) {
+  return objectToMap(object);
+}
+function objectToReverseMap(object) {
+  const map = /* @__PURE__ */ new Map();
+  for (const [key, value] of Object.entries(object)) {
+    map.set(value, key);
+  }
+  return map;
+}
+function objectToReverseReadonlyMap(object) {
+  return objectToReverseMap(object);
+}
 
 function addSetsToSet(mainSet, ...setsToAdd) {
   for (const set of setsToAdd) {
@@ -450,6 +486,13 @@ function truncateString(string, maxLength) {
   return string.slice(0, maxLength);
 }
 
+function getElapsedSeconds(startTime) {
+  const endTime = Date.now();
+  const elapsedMilliseconds = endTime - startTime;
+  const elapsedSeconds = elapsedMilliseconds / 1e3;
+  return Math.floor(elapsedSeconds);
+}
+
 function* tupleEntries(tuple) {
   yield* tuple.entries();
 }
@@ -457,10 +500,6 @@ function* tupleKeys(tuple) {
   yield* tuple.keys();
 }
 
-function isObject(variable) {
-  return typeof variable === "object" && variable !== null && !Array.isArray(variable);
-}
-
 const ReadonlyMap = Map;
 
 exports.HOUR_IN_MILLISECONDS = HOUR_IN_MILLISECONDS;
@@ -475,6 +514,8 @@ exports.arrayRemove = arrayRemove;
 exports.arrayRemoveInPlace = arrayRemoveInPlace;
 exports.assertDefined = assertDefined;
 exports.assertNotNull = assertNotNull;
+exports.assertObject = assertObject;
+exports.assertType = assertType;
 exports.capitalizeFirstLetter = capitalizeFirstLetter;
 exports.clamp = clamp;
 exports.combineSets = combineSets;
@@ -483,6 +524,7 @@ exports.eRange = eRange;
 exports.emptyArray = emptyArray;
 exports.escapeHTMLCharacters = escapeHTMLCharacters;
 exports.filterMap = filterMap;
+exports.getElapsedSeconds = getElapsedSeconds;
 exports.getEnumEntries = getEnumEntries;
 exports.getEnumKeys = getEnumKeys;
 exports.getEnumValues = getEnumValues;
@@ -514,6 +556,8 @@ exports.objectKeysToReadonlySet = objectKeysToReadonlySet;
 exports.objectKeysToSet = objectKeysToSet;
 exports.objectToMap = objectToMap;
 exports.objectToReadonlyMap = objectToReadonlyMap;
+exports.objectToReverseMap = objectToReverseMap;
+exports.objectToReverseReadonlyMap = objectToReverseReadonlyMap;
 exports.objectValuesToReadonlySet = objectValuesToReadonlySet;
 exports.objectValuesToSet = objectValuesToSet;
 exports.parseFloatSafe = parseFloatSafe;

package/dist/index.d.cts

@@ -9,6 +9,7 @@ export * from "./functions/random.js";
 export * from "./functions/set.js";
 export * from "./functions/sort.js";
 export * from "./functions/string.js";
+export * from "./functions/time.js";
 export * from "./functions/tuple.js";
 export * from "./functions/types.js";
 export * from "./functions/utils.js";

package/dist/index.d.mts

@@ -9,6 +9,7 @@ export * from "./functions/random.js";
 export * from "./functions/set.js";
 export * from "./functions/sort.js";
 export * from "./functions/string.js";
+export * from "./functions/time.js";
 export * from "./functions/tuple.js";
 export * from "./functions/types.js";
 export * from "./functions/utils.js";

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export * from "./functions/random.js";
 export * from "./functions/set.js";
 export * from "./functions/sort.js";
 export * from "./functions/string.js";
+export * from "./functions/time.js";
 export * from "./functions/tuple.js";
 export * from "./functions/types.js";
 export * from "./functions/utils.js";

package/dist/index.d.ts.map

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

package/dist/index.mjs

@@ -4,6 +4,21 @@ const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;
 
 const ReadonlySet = Set;
 
+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 assertDefined(value, ...[msg]) {
   if (value === void 0) {
     throw new TypeError(msg);
@@ -14,6 +29,17 @@ function assertNotNull(value, ...[msg]) {
     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)) {
+    throw new TypeError(msg);
+  }
+}
 
 function getRandomInt(min, max, exceptions = []) {
   min = Math.ceil(min);
@@ -164,16 +190,6 @@ function mapFind(map, predicate) {
   }
   return void 0;
 }
-function objectToMap(object) {
-  const map = /* @__PURE__ */ new Map();
-  for (const [key, value] of Object.entries(object)) {
-    map.set(key, value);
-  }
-  return map;
-}
-function objectToReadonlyMap(object) {
-  return objectToMap(object);
-}
 
 function clamp(num, min, max) {
   return Math.max(min, Math.min(num, max));
@@ -190,6 +206,26 @@ function objectFilter(object, predicate) {
   }
   return array;
 }
+function objectToMap(object) {
+  const map = /* @__PURE__ */ new Map();
+  for (const [key, value] of Object.entries(object)) {
+    map.set(key, value);
+  }
+  return map;
+}
+function objectToReadonlyMap(object) {
+  return objectToMap(object);
+}
+function objectToReverseMap(object) {
+  const map = /* @__PURE__ */ new Map();
+  for (const [key, value] of Object.entries(object)) {
+    map.set(value, key);
+  }
+  return map;
+}
+function objectToReverseReadonlyMap(object) {
+  return objectToReverseMap(object);
+}
 
 function addSetsToSet(mainSet, ...setsToAdd) {
   for (const set of setsToAdd) {
@@ -448,6 +484,13 @@ function truncateString(string, maxLength) {
   return string.slice(0, maxLength);
 }
 
+function getElapsedSeconds(startTime) {
+  const endTime = Date.now();
+  const elapsedMilliseconds = endTime - startTime;
+  const elapsedSeconds = elapsedMilliseconds / 1e3;
+  return Math.floor(elapsedSeconds);
+}
+
 function* tupleEntries(tuple) {
   yield* tuple.entries();
 }
@@ -455,10 +498,6 @@ function* tupleKeys(tuple) {
   yield* tuple.keys();
 }
 
-function isObject(variable) {
-  return typeof variable === "object" && variable !== null && !Array.isArray(variable);
-}
-
 const ReadonlyMap = Map;
 
-export { HOUR_IN_MILLISECONDS, MINUTE_IN_MILLISECONDS, ReadonlyMap, ReadonlySet, SECOND_IN_MILLISECONDS, addSetsToSet, arrayCopyTwoDimensional, arrayEquals, arrayRemove, arrayRemoveInPlace, assertDefined, assertNotNull, capitalizeFirstLetter, clamp, combineSets, copySet, eRange, emptyArray, escapeHTMLCharacters, filterMap, 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, 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, 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "complete-common",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "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.7.7",
-    "complete-node": "^1.7.4",
-    "eslint-plugin-sort-exports": "^0.9.1",
-    "glob": "^11.0.0",
-    "typescript": "^5.6.3",
-    "typescript-eslint": "^8.10.0",
-    "unbuild": "^2.0.0"
+    "@types/node": "22.13.5",
+    "complete-node": "3.0.0",
+    "eslint-plugin-sort-exports": "0.9.1",
+    "glob": "11.0.1",
+    "typescript": "5.7.3",
+    "typescript-eslint": "8.24.1",
+    "unbuild": "3.3.1"
   }
 }

package/src/functions/assert.ts

@@ -4,6 +4,21 @@
  * @module
  */
 
+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 equal to `undefined`.
  *
@@ -39,3 +54,33 @@ export function assertNotNull<T>(
     throw new TypeError(msg);
   }
 }
+
+/**
+ * Helper function to throw an error if the provided value is not an object (i.e. a TypeScript
+ * record).
+ *
+ * This is useful to have TypeScript narrow a `Record<string, unknown> | undefined` value to
+ * `Record<string, unknown>` in a concise way.
+ *
+ * Under the hood, this function uses the `isObject` helper function.
+ */
+export function assertObject(
+  value: unknown,
+  msg: string,
+): asserts value is Record<string, unknown> {
+  if (!isObject(value)) {
+    throw new TypeError(msg);
+  }
+}
+
+/** Helper function to throw an error if the provided value is not of the provided type. */
+export function assertType(
+  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)) {
+    throw new TypeError(msg);
+  }
+}

package/src/functions/map.ts

@@ -50,48 +50,3 @@ export function mapFind<K, V>(
 
   return undefined;
 }
-
-/**
- * Helper function to convert an object to a map.
- *
- * This is useful when you need to construct a type safe object with the `satisfies` operator, but
- * then later on you need to query it in a way where you expect the return value to be T or
- * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
- * assertions.
- *
- * Note that the map values will be inserted in a random order, due to how `pairs` works under the
- * hood.
- *
- * Also see the `objectToReadonlyMap` function.
- */
-// eslint-disable-next-line complete/no-mutable-return
-export function objectToMap<K extends string | number | symbol, V>(
-  object: Record<K, V>,
-): Map<K, V> {
-  const map = new Map<K, V>();
-
-  for (const [key, value] of Object.entries(object)) {
-    map.set(key as K, value as V);
-  }
-
-  return map;
-}
-
-/**
- * Helper function to convert an object to a read-only map.
- *
- * This is useful when you need to construct a type safe object with the `satisfies` operator, but
- * then later on you need to query it in a way where you expect the return value to be T or
- * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
- * assertions.
- *
- * Note that the map values will be inserted in a random order, due to how `pairs` works under the
- * hood.
- *
- * Also see the `objectToMap` function.
- */
-export function objectToReadonlyMap<K extends string | number | symbol, V>(
-  object: Record<K, V>,
-): ReadonlyMap<K, V> {
-  return objectToMap(object);
-}

package/src/functions/object.ts

@@ -30,3 +30,85 @@ export function objectFilter<K extends string | number | symbol, V>(
 
   return array;
 }
+
+/**
+ * Helper function to convert an object to a map.
+ *
+ * This is useful when you need to construct a type safe object with the `satisfies` operator, but
+ * then later on you need to query it in a way where you expect the return value to be T or
+ * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
+ * assertions.
+ *
+ * Note that the converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys under the hood.
+ *
+ * Also see the `objectToReadonlyMap` function.
+ */
+// eslint-disable-next-line complete/no-mutable-return
+export function objectToMap<K extends string | number | symbol, V>(
+  object: Record<K, V>,
+): Map<K, V> {
+  const map = new Map<K, V>();
+
+  for (const [key, value] of Object.entries(object)) {
+    map.set(key as K, value as V);
+  }
+
+  return map;
+}
+
+/**
+ * Helper function to convert an object to a read-only map.
+ *
+ * This is useful when you need to construct a type safe object with the `satisfies` operator, but
+ * then later on you need to query it in a way where you expect the return value to be T or
+ * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
+ * assertions.
+ *
+ * Note that the converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys under the hood.
+ *
+ * Also see the `objectToMap` function.
+ */
+export function objectToReadonlyMap<K extends string | number | symbol, V>(
+  object: Record<K, V>,
+): ReadonlyMap<K, V> {
+  return objectToMap(object);
+}
+
+/**
+ * Helper function to convert an object to a reverse map.
+ *
+ * Note that the converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys under the hood.
+ *
+ * Also see the `objectToReverseReadonlyMap` function.
+ */
+// eslint-disable-next-line complete/no-mutable-return
+export function objectToReverseMap<
+  K extends string | number | symbol,
+  V extends string | number | symbol,
+>(object: Record<K, V>): Map<V, K> {
+  const map = new Map<V, K>();
+
+  for (const [key, value] of Object.entries(object)) {
+    map.set(value as V, key as K);
+  }
+
+  return map;
+}
+
+/**
+ * Helper function to convert an object to a reverse read-only map.
+ *
+ * Note that the converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys under the hood.
+ *
+ * Also see the `objectToReverseMap` function.
+ */
+export function objectToReverseReadonlyMap<
+  K extends string | number | symbol,
+  V extends string | number | symbol,
+>(object: Record<K, V>): ReadonlyMap<V, K> {
+  return objectToReverseMap(object);
+}

package/src/functions/time.ts

@@ -0,0 +1,26 @@
+/**
+ * Helper functions having to do with time.
+ *
+ * @module
+ */
+
+/**
+ * Helper function to get the number of elapsed seconds since a starting time.
+ *
+ * This function always returns a whole number (using `Math.floor` on the result).
+ *
+ * For example:
+ *
+ * ```ts
+ * const startTime = Date.now();
+ * doSomething();
+ * const elapsedSeconds = getElapsedSeconds(startTime);
+ * ```
+ */
+export function getElapsedSeconds(startTime: number): number {
+  const endTime = Date.now();
+  const elapsedMilliseconds = endTime - startTime;
+  const elapsedSeconds = elapsedMilliseconds / 1000;
+
+  return Math.floor(elapsedSeconds);
+}

package/src/index.ts

@@ -9,6 +9,7 @@ export * from "./functions/random.js";
 export * from "./functions/set.js";
 export * from "./functions/sort.js";
 export * from "./functions/string.js";
+export * from "./functions/time.js";
 export * from "./functions/tuple.js";
 export * from "./functions/types.js";
 export * from "./functions/utils.js";