complete-common 2.31.0 → 2.32.0

package/dist/functions/object.d.cts

@@ -5,6 +5,22 @@
  */
 import type { ReadonlyRecord } from "../types/ReadonlyRecord.js";
 import type { WidenLiteral } from "../types/WidenLiteral.js";
+/**
+ * Helper function to get the keys and values of an object with their literal key types preserved.
+ *
+ * This is a typed wrapper around `Object.entries`. The type assertion is necessary because
+ * TypeScript defines the keys from `Object.entries` as being `string[]`.
+ */
+export declare function getObjectEntries<const T extends object>(object: T): ReadonlyArray<{
+    [K in keyof T]: [K, T[K]];
+}[keyof T]>;
+/**
+ * Helper function to get keys of an object with their literal key types preserved.
+ *
+ * This is a typed wrapper around `Object.keys`. The type assertion is necessary because TypeScript
+ * defines `Object.keys` as returning `string[]`.
+ */
+export declare function getObjectKeys<const T extends object>(object: T): ReadonlyArray<keyof T>;
 /**
  * Safely gets a value from a widened object.
  *

package/dist/functions/object.d.mts

@@ -5,6 +5,22 @@
  */
 import type { ReadonlyRecord } from "../types/ReadonlyRecord.js";
 import type { WidenLiteral } from "../types/WidenLiteral.js";
+/**
+ * Helper function to get the keys and values of an object with their literal key types preserved.
+ *
+ * This is a typed wrapper around `Object.entries`. The type assertion is necessary because
+ * TypeScript defines the keys from `Object.entries` as being `string[]`.
+ */
+export declare function getObjectEntries<const T extends object>(object: T): ReadonlyArray<{
+    [K in keyof T]: [K, T[K]];
+}[keyof T]>;
+/**
+ * Helper function to get keys of an object with their literal key types preserved.
+ *
+ * This is a typed wrapper around `Object.keys`. The type assertion is necessary because TypeScript
+ * defines `Object.keys` as returning `string[]`.
+ */
+export declare function getObjectKeys<const T extends object>(object: T): ReadonlyArray<keyof T>;
 /**
  * Safely gets a value from a widened object.
  *

package/dist/functions/object.d.ts

@@ -5,6 +5,22 @@
  */
 import type { ReadonlyRecord } from "../types/ReadonlyRecord.js";
 import type { WidenLiteral } from "../types/WidenLiteral.js";
+/**
+ * Helper function to get the keys and values of an object with their literal key types preserved.
+ *
+ * This is a typed wrapper around `Object.entries`. The type assertion is necessary because
+ * TypeScript defines the keys from `Object.entries` as being `string[]`.
+ */
+export declare function getObjectEntries<const T extends object>(object: T): ReadonlyArray<{
+    [K in keyof T]: [K, T[K]];
+}[keyof T]>;
+/**
+ * Helper function to get keys of an object with their literal key types preserved.
+ *
+ * This is a typed wrapper around `Object.keys`. The type assertion is necessary because TypeScript
+ * defines `Object.keys` as returning `string[]`.
+ */
+export declare function getObjectKeys<const T extends object>(object: T): ReadonlyArray<keyof T>;
 /**
  * Safely gets a value from a widened object.
  *

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;AACjE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE7D;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrE,MAAM,EAAE,CAAC,EACT,GAAG,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,GACzB,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,CAGxB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,WAAW,EAAE,CAAC,EACnD,MAAM,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5B,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAC/B,SAAS,CAAC,EAAE,CAad;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,WAAW,EAAE,CAAC,EAAE,CAAC,EACnD,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC,GAChC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAOtB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,WAAW,EAAE,CAAC,EAClD,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAQnB;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,WAAW,EACrB,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAQzC;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,WAAW,EAAE,CAAC,SAAS,WAAW,EACxE,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAChB,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAStB"}
+{"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;AACjE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE7D;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,EACrD,MAAM,EAAE,CAAC,GACR,aAAa,CAAC;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAMvD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,EAClD,MAAM,EAAE,CAAC,GACR,aAAa,CAAC,MAAM,CAAC,CAAC,CAExB;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrE,MAAM,EAAE,CAAC,EACT,GAAG,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,GACzB,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,CAGxB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,WAAW,EAAE,CAAC,EACnD,MAAM,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5B,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAC/B,SAAS,CAAC,EAAE,CAad;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,WAAW,EAAE,CAAC,EAAE,CAAC,EACnD,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC,GAChC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAOtB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,WAAW,EAAE,CAAC,EAClD,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAQnB;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,WAAW,EACrB,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAQzC;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,WAAW,EAAE,CAAC,SAAS,WAAW,EACxE,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAChB,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAStB"}

package/dist/functions/time.d.cts

@@ -6,7 +6,8 @@
 /**
  * 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).
+ * By default, this function will return a whole number (using `Math.floor` on the result), but this
+ * can be disabled with the "roundToInteger" parameter.
  *
  * For example:
  *

package/dist/functions/time.d.mts

@@ -6,7 +6,8 @@
 /**
  * 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).
+ * By default, this function will return a whole number (using `Math.floor` on the result), but this
+ * can be disabled with the "roundToInteger" parameter.
  *
  * For example:
  *

package/dist/functions/time.d.ts

@@ -6,7 +6,8 @@
 /**
  * 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).
+ * By default, this function will return a whole number (using `Math.floor` on the result), but this
+ * can be disabled with the "roundToInteger" parameter.
  *
  * For example:
  *

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

@@ -1 +1 @@
-{"version":3,"file":"time.d.ts","sourceRoot":"","sources":["../../src/functions/time.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,MAAM,EACjB,cAAc,UAAO,GACpB,MAAM,CAMR"}
+{"version":3,"file":"time.d.ts","sourceRoot":"","sources":["../../src/functions/time.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;;;;;;GAaG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,MAAM,EACjB,cAAc,UAAO,GACpB,MAAM,CAMR"}

package/dist/index.cjs

@@ -333,6 +333,12 @@ function clamp(num, min, max) {
   return Math.max(min, Math.min(num, max));
 }
 
+function getObjectEntries(object) {
+  return Object.entries(object);
+}
+function getObjectKeys(object) {
+  return Object.keys(object);
+}
 function getWidenedObjectValue(object, key) {
   const widenedObject = object;
   return widenedObject[key];
@@ -726,6 +732,8 @@ exports.getEnumEntries = getEnumEntries;
 exports.getEnumKeys = getEnumKeys;
 exports.getEnumValues = getEnumValues;
 exports.getNumConsecutiveDiacritics = getNumConsecutiveDiacritics;
+exports.getObjectEntries = getObjectEntries;
+exports.getObjectKeys = getObjectKeys;
 exports.getRandomArrayElement = getRandomArrayElement;
 exports.getRandomArrayIndex = getRandomArrayIndex;
 exports.getRandomInt = getRandomInt;

package/dist/index.mjs

@@ -331,6 +331,12 @@ function clamp(num, min, max) {
   return Math.max(min, Math.min(num, max));
 }
 
+function getObjectEntries(object) {
+  return Object.entries(object);
+}
+function getObjectKeys(object) {
+  return Object.keys(object);
+}
 function getWidenedObjectValue(object, key) {
   const widenedObject = object;
   return widenedObject[key];
@@ -680,4 +686,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, assertArrayLength, assertArrayNonEmpty, assertArrayNumber, assertArrayObject, assertArrayString, assertBoolean, assertDefined, assertEnumValue, assertInteger, assertIs, assertNotNull, assertNumber, assertObject, assertPositiveInteger, assertString, assertStringNotEmpty, capitalizeFirstLetter, clamp, combineSets, copySet, eRange, emptyArray, escapeHTMLCharacters, filterAsync, filterMap, filterMapAsync, getElapsedSeconds, getEnumEntries, getEnumKeys, getEnumValues, getNumConsecutiveDiacritics, getRandomArrayElement, getRandomArrayIndex, getRandomInt, getWidenedObjectValue, hasDiacritic, hasEmoji, hasWhitespace, iRange, includes, includesAny, interfaceSatisfiesEnum, isASCII, isArray, isArrayBoolean, isArrayNumber, isArrayObject, isArrayString, isEnumValue, isFirstLetterCapitalized, isKebabCase, isKeyOf, isLowerCase, isObject, isSemanticVersion, isUpperCase, kebabCaseToCamelCase, kebabCaseToPascalCase, mapAsync, mapFilter, mapFind, newArray, noop, normalizeString, objectFilter, objectKeysToSet, objectMap, objectToMap, objectToReverseMap, objectValuesToSet, parseFloatSafe, parseIntSafe, parseSemanticVersion, removeLinesBetweenMarkers, removeLinesMatching, removeNonPrintableCharacters, removeWhitespace, repeat, reverseObject, satisfiesSemanticVersion, setAdd, setHas, sortCaseInsensitive, sumArray, titleCaseToKebabCase, todo, trimPrefix, trimSuffix, truncateString, tupleEntries, tupleKeys, unique };
+export { HOUR_IN_MILLISECONDS, MINUTE_IN_MILLISECONDS, ReadonlyMap, ReadonlySet, SECOND_IN_MILLISECONDS, addSetsToSet, arrayCopyTwoDimensional, arrayEquals, arrayRemove, arrayRemoveAllInPlace, arrayRemoveInPlace, assertArray, assertArrayBoolean, assertArrayLength, assertArrayNonEmpty, assertArrayNumber, assertArrayObject, assertArrayString, assertBoolean, assertDefined, assertEnumValue, assertInteger, assertIs, assertNotNull, assertNumber, assertObject, assertPositiveInteger, assertString, assertStringNotEmpty, capitalizeFirstLetter, clamp, combineSets, copySet, eRange, emptyArray, escapeHTMLCharacters, filterAsync, filterMap, filterMapAsync, getElapsedSeconds, getEnumEntries, getEnumKeys, getEnumValues, getNumConsecutiveDiacritics, getObjectEntries, getObjectKeys, getRandomArrayElement, getRandomArrayIndex, getRandomInt, getWidenedObjectValue, hasDiacritic, hasEmoji, hasWhitespace, iRange, includes, includesAny, interfaceSatisfiesEnum, isASCII, isArray, isArrayBoolean, isArrayNumber, isArrayObject, isArrayString, isEnumValue, isFirstLetterCapitalized, isKebabCase, isKeyOf, isLowerCase, isObject, isSemanticVersion, isUpperCase, kebabCaseToCamelCase, kebabCaseToPascalCase, mapAsync, mapFilter, mapFind, newArray, noop, normalizeString, objectFilter, objectKeysToSet, objectMap, objectToMap, objectToReverseMap, objectValuesToSet, parseFloatSafe, parseIntSafe, parseSemanticVersion, removeLinesBetweenMarkers, removeLinesMatching, removeNonPrintableCharacters, removeWhitespace, repeat, reverseObject, satisfiesSemanticVersion, setAdd, setHas, sortCaseInsensitive, sumArray, titleCaseToKebabCase, todo, trimPrefix, trimSuffix, truncateString, tupleEntries, tupleKeys, unique };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "complete-common",
-  "version": "2.31.0",
+  "version": "2.32.0",
   "description": "Helper functions for TypeScript projects.",
   "homepage": "https://complete-ts.github.io/",
   "bugs": {
@@ -32,7 +32,7 @@
     "test": "bun test ./tests"
   },
   "devDependencies": {
-    "@types/node": "26.0.1",
+    "@types/node": "26.1.0",
     "complete-node": "18.0.0",
     "typedoc": "0.28.19",
     "typedoc-plugin-markdown": "4.12.0",

package/src/functions/object.ts

@@ -7,6 +7,34 @@
 import type { ReadonlyRecord } from "../types/ReadonlyRecord.js";
 import type { WidenLiteral } from "../types/WidenLiteral.js";
 
+/**
+ * Helper function to get the keys and values of an object with their literal key types preserved.
+ *
+ * This is a typed wrapper around `Object.entries`. The type assertion is necessary because
+ * TypeScript defines the keys from `Object.entries` as being `string[]`.
+ */
+export function getObjectEntries<const T extends object>(
+  object: T,
+): ReadonlyArray<{ [K in keyof T]: [K, T[K]] }[keyof T]> {
+  return Object.entries(object) as Array<
+    {
+      [K in keyof T]: [K, T[K]];
+    }[keyof T]
+  >;
+}
+
+/**
+ * Helper function to get keys of an object with their literal key types preserved.
+ *
+ * This is a typed wrapper around `Object.keys`. The type assertion is necessary because TypeScript
+ * defines `Object.keys` as returning `string[]`.
+ */
+export function getObjectKeys<const T extends object>(
+  object: T,
+): ReadonlyArray<keyof T> {
+  return Object.keys(object) as Array<keyof T>;
+}
+
 /**
  * Safely gets a value from a widened object.
  *

package/src/functions/time.ts

@@ -7,7 +7,8 @@
 /**
  * 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).
+ * By default, this function will return a whole number (using `Math.floor` on the result), but this
+ * can be disabled with the "roundToInteger" parameter.
  *
  * For example:
  *