complete-common 1.0.0 → 1.0.1

package/dist/types/ReadonlyRecord.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Helper type to specify that a record should be read-only.
+ *
+ * This is the same thing as `Readonly<Record<K, V>>`.
+ */
+export type ReadonlyRecord<K extends string | number | symbol, V> = Readonly<Record<K, V>>;
+//# sourceMappingURL=ReadonlyRecord.d.ts.map

package/dist/types/ReadonlyRecord.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadonlyRecord.d.ts","sourceRoot":"","sources":["../../src/types/ReadonlyRecord.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,IAAI,QAAQ,CAC1E,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CACb,CAAC"}

package/dist/types/ReadonlySet.d.cts

@@ -0,0 +1,8 @@
+interface ReadonlySetConstructor {
+    new <T = any>(values?: readonly T[] | Iterable<T> | null): ReadonlySet<T>;
+    readonly prototype: ReadonlySet<any>;
+}
+/** An alias for the `Set` constructor that returns a read-only set. */
+export declare const ReadonlySet: ReadonlySetConstructor;
+export {};
+//# sourceMappingURL=ReadonlySet.d.ts.map

package/dist/types/ReadonlySet.d.mts

@@ -0,0 +1,8 @@
+interface ReadonlySetConstructor {
+    new <T = any>(values?: readonly T[] | Iterable<T> | null): ReadonlySet<T>;
+    readonly prototype: ReadonlySet<any>;
+}
+/** An alias for the `Set` constructor that returns a read-only set. */
+export declare const ReadonlySet: ReadonlySetConstructor;
+export {};
+//# sourceMappingURL=ReadonlySet.d.ts.map

package/dist/types/ReadonlySet.d.ts

@@ -0,0 +1,8 @@
+interface ReadonlySetConstructor {
+    new <T = any>(values?: readonly T[] | Iterable<T> | null): ReadonlySet<T>;
+    readonly prototype: ReadonlySet<any>;
+}
+/** An alias for the `Set` constructor that returns a read-only set. */
+export declare const ReadonlySet: ReadonlySetConstructor;
+export {};
+//# sourceMappingURL=ReadonlySet.d.ts.map

package/dist/types/ReadonlySet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadonlySet.d.ts","sourceRoot":"","sources":["../../src/types/ReadonlySet.ts"],"names":[],"mappings":"AAEA,UAAU,sBAAsB;IAC9B,KAAK,CAAC,GAAG,GAAG,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAC1E,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;CACtC;AAED,uEAAuE;AACvE,eAAO,MAAM,WAAW,EAAU,sBAAsB,CAAC"}

package/dist/types/Tuple.d.cts

@@ -0,0 +1,10 @@
+/**
+ * Helper type to represent a tuple of length N.
+ *
+ * From:
+ * https://stackoverflow.com/questions/52489261/typescript-can-i-define-an-n-length-tuple-type/52490977#52490977
+ */
+export type Tuple<T, N extends number> = N extends N ? number extends N ? T[] : _TupleOf<T, N, []> : never;
+type _TupleOf<T, N extends number, R extends unknown[]> = R["length"] extends N ? R : _TupleOf<T, N, [T, ...R]>;
+export {};
+//# sourceMappingURL=Tuple.d.ts.map

package/dist/types/Tuple.d.mts

@@ -0,0 +1,10 @@
+/**
+ * Helper type to represent a tuple of length N.
+ *
+ * From:
+ * https://stackoverflow.com/questions/52489261/typescript-can-i-define-an-n-length-tuple-type/52490977#52490977
+ */
+export type Tuple<T, N extends number> = N extends N ? number extends N ? T[] : _TupleOf<T, N, []> : never;
+type _TupleOf<T, N extends number, R extends unknown[]> = R["length"] extends N ? R : _TupleOf<T, N, [T, ...R]>;
+export {};
+//# sourceMappingURL=Tuple.d.ts.map

package/dist/types/Tuple.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Helper type to represent a tuple of length N.
+ *
+ * From:
+ * https://stackoverflow.com/questions/52489261/typescript-can-i-define-an-n-length-tuple-type/52490977#52490977
+ */
+export type Tuple<T, N extends number> = N extends N ? number extends N ? T[] : _TupleOf<T, N, []> : never;
+type _TupleOf<T, N extends number, R extends unknown[]> = R["length"] extends N ? R : _TupleOf<T, N, [T, ...R]>;
+export {};
+//# sourceMappingURL=Tuple.d.ts.map

package/dist/types/Tuple.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tuple.d.ts","sourceRoot":"","sources":["../../src/types/Tuple.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,CAAC,GAChD,MAAM,SAAS,CAAC,GACd,CAAC,EAAE,GACH,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GACpB,KAAK,CAAC;AAEV,KAAK,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,OAAO,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GAC3E,CAAC,GACD,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC"}

package/dist/types/WidenLiteral.d.cts

@@ -0,0 +1,3 @@
+/** Helper type used to widen a const array to the corresponding base type. */
+export type WidenLiteral<T> = T extends string ? string : T extends number ? number : T extends boolean ? boolean : T extends bigint ? bigint : T extends symbol ? symbol : T;
+//# sourceMappingURL=WidenLiteral.d.ts.map

package/dist/types/WidenLiteral.d.mts

@@ -0,0 +1,3 @@
+/** Helper type used to widen a const array to the corresponding base type. */
+export type WidenLiteral<T> = T extends string ? string : T extends number ? number : T extends boolean ? boolean : T extends bigint ? bigint : T extends symbol ? symbol : T;
+//# sourceMappingURL=WidenLiteral.d.ts.map

package/dist/types/WidenLiteral.d.ts

@@ -0,0 +1,3 @@
+/** Helper type used to widen a const array to the corresponding base type. */
+export type WidenLiteral<T> = T extends string ? string : T extends number ? number : T extends boolean ? boolean : T extends bigint ? bigint : T extends symbol ? symbol : T;
+//# sourceMappingURL=WidenLiteral.d.ts.map

package/dist/types/WidenLiteral.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WidenLiteral.d.ts","sourceRoot":"","sources":["../../src/types/WidenLiteral.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAC1C,MAAM,GACN,CAAC,SAAS,MAAM,GACd,MAAM,GACN,CAAC,SAAS,OAAO,GACf,OAAO,GACP,CAAC,SAAS,MAAM,GACd,MAAM,GACN,CAAC,SAAS,MAAM,GACd,MAAM,GACN,CAAC,CAAC"}

package/dist/types/Writeable.d.cts

@@ -0,0 +1,9 @@
+/**
+ * Helper type to convert a read-only object into a writable object.
+ *
+ * This is the opposite of the built-in `Readonly` utility type.
+ */
+export type Writeable<T> = {
+    -readonly [P in keyof T]: T[P];
+};
+//# sourceMappingURL=Writeable.d.ts.map

package/dist/types/Writeable.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Helper type to convert a read-only object into a writable object.
+ *
+ * This is the opposite of the built-in `Readonly` utility type.
+ */
+export type Writeable<T> = {
+    -readonly [P in keyof T]: T[P];
+};
+//# sourceMappingURL=Writeable.d.ts.map

package/dist/types/Writeable.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Helper type to convert a read-only object into a writable object.
+ *
+ * This is the opposite of the built-in `Readonly` utility type.
+ */
+export type Writeable<T> = {
+    -readonly [P in keyof T]: T[P];
+};
+//# sourceMappingURL=Writeable.d.ts.map

package/dist/types/Writeable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Writeable.d.ts","sourceRoot":"","sources":["../../src/types/Writeable.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC"}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "complete-common",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Helper functions for TypeScript projects.",
   "keywords": [],
-  "homepage": "https://complete-js.github.io/",
+  "homepage": "https://complete-ts.github.io/",
   "bugs": {
     "url": "https://github.com/complete-ts/complete/issues"
   },
@@ -30,7 +30,17 @@
   ],
   "scripts": {
     "build": "tsx ./scripts/build.ts",
+    "docs": "typedoc",
     "lint": "tsx ./scripts/lint.ts",
     "test": "glob \"./src/**/*.test.ts\" --cmd=\"node --import tsx --test --test-reporter spec\""
+  },
+  "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"
   }
 }

package/src/constants.ts

@@ -1,3 +1,8 @@
+/** Equal to 1000. */
 export const SECOND_IN_MILLISECONDS = 1000;
+
+/** Equal to 60,000. */
 export const MINUTE_IN_MILLISECONDS = 60 * SECOND_IN_MILLISECONDS;
+
+/** Equal to 3,600,000. */
 export const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;

package/src/functions/array.ts

@@ -1,7 +1,13 @@
+/**
+ * Helper functions that have to do with arrays.
+ *
+ * @module
+ */
+
 import type { WidenLiteral } from "../index.js";
 import { ReadonlySet } from "../types/ReadonlySet.js";
+import { assertDefined } from "./assert.js";
 import { getRandomInt } from "./random.js";
-import { assertDefined } from "./utils.js";
 
 /**
  * Helper function to copy a two-dimensional array. Note that the sub-arrays will only be shallow
@@ -84,7 +90,7 @@ export function arrayRemoveInPlace<T>(
 
   for (const element of elementsToRemove) {
     const index = array.indexOf(element);
-    if (index > -1) {
+    if (index !== -1) {
       const removedElement = array.splice(index, 1);
       removedElements.push(...removedElement);
     }

package/src/functions/assert.ts

@@ -0,0 +1,41 @@
+/**
+ * Helper functions that have to do with asserting.
+ *
+ * @module
+ */
+
+/**
+ * Helper function to throw an error if the provided value is equal to `undefined`.
+ *
+ * This is useful to have TypeScript narrow a `T | undefined` value to `T` in a concise way.
+ */
+export function assertDefined<T>(
+  value: T,
+  ...[msg]: [undefined] extends [T]
+    ? [string]
+    : [
+        "The assertion is useless because the provided value does not contain undefined.",
+      ]
+): asserts value is Exclude<T, undefined> {
+  if (value === undefined) {
+    throw new TypeError(msg);
+  }
+}
+
+/**
+ * Helper function to throw an error if the provided value is equal to `null`.
+ *
+ * This is useful to have TypeScript narrow a `T | null` value to `T` in a concise way.
+ */
+export 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> {
+  if (value === null) {
+    throw new TypeError(msg);
+  }
+}

package/src/functions/enums.ts

@@ -1,3 +1,9 @@
+/**
+ * Helper functions that have to do with TypeScript enums.
+ *
+ * @module
+ */
+
 type TranspiledEnum = Record<string, string | number>;
 
 /**

package/src/functions/map.ts

@@ -1,3 +1,10 @@
+/**
+ * Helper functions that have to do with
+ * [maps](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map).
+ *
+ * @module
+ */
+
 /**
  * Helper function to get the values in a `Map` that match an arbitrary condition. Similar to the
  * `Array.map` method, but works for maps.

package/src/functions/math.ts

@@ -1,3 +1,9 @@
+/**
+ * Helper functions that have to do with math.
+ *
+ * @module
+ */
+
 /**
  * Helper function to normalize a number, ensuring that it is within a certain range.
  *

package/src/functions/object.ts

@@ -1,12 +1,17 @@
 /**
- * Helper function to get the values in an object that match an arbitrary condition. Similar to the
- * `Array.map` method, but works for objects.
+ * Helper functions that have to do with objects.
  *
- * This is efficient such that it avoids converting the object values into an array.
+ * @module
  */
 
 import type { ReadonlyRecord } from "../types/ReadonlyRecord.js";
 
+/**
+ * Helper function to get the values in an object that match an arbitrary condition. Similar to the
+ * `Array.map` method, but works for objects.
+ *
+ * This is efficient such that it avoids converting the object values into an array.
+ */
 // eslint-disable-next-line complete/no-mutable-return
 export function objectFilter<K extends string | number | symbol, V>(
   object: ReadonlyRecord<K, V>,

package/src/functions/random.ts

@@ -1,3 +1,9 @@
+/**
+ * Helper functions that have to do with getting random values.
+ *
+ * @module
+ */
+
 import { ReadonlySet } from "../types/ReadonlySet.js";
 
 /**

package/src/functions/set.ts

@@ -1,3 +1,10 @@
+/**
+ * Helper functions that have to do with
+ * [sets](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set).
+ *
+ * @module
+ */
+
 /**
  * Helper function to add all of the values in one set to another set. The first set passed will be
  * modified in place.

package/src/functions/sort.ts

@@ -1,3 +1,9 @@
+/**
+ * Helper functions that have to do with sorting.
+ *
+ * @module
+ */
+
 /**
  * Helper function to perform a case insensitive sort. This will copy the provided array and return
  * the sorted copy.

package/src/functions/string.ts

@@ -1,3 +1,9 @@
+/**
+ * Helper functions that have to do with strings.
+ *
+ * @module
+ */
+
 import { parseIntSafe } from "./utils.js";
 
 // When regular expressions are located at the root instead of inside the function, the functions
@@ -17,6 +23,7 @@ const KEBAB_CASE_REGEX =
 const SEMANTIC_VERSION_REGEX = /^v*(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)/;
 const WHITESPACE_REGEX = /\s/g;
 
+/** Helper function to capitalize the first letter of a string. */
 export function capitalizeFirstLetter(string: string): string {
   if (string === "") {
     return string;
@@ -43,6 +50,12 @@ export function escapeHTMLCharacters(string: string): string {
     .replaceAll("'", "&#039;");
 }
 
+/**
+ * Helper function to get the number of consecutive diacritics in a string.
+ *
+ * This is useful for sanitization purposes, since many subsequent diacritics can be a sign of a
+ * malicious string.
+ */
 export function getNumConsecutiveDiacritics(string: string): number {
   // First, normalize with Normalization Form Canonical Decomposition (NFD) so that diacritics are
   // separated from other characters:
@@ -66,6 +79,7 @@ export function getNumConsecutiveDiacritics(string: string): number {
   return maxConsecutiveDiacritic;
 }
 
+/** Helper function to check if a string has one or more diacritics in it. */
 export function hasDiacritic(string: string): boolean {
   // First, normalize with Normalization Form Canonical Decomposition (NFD) so that diacritics are
   // separated from other characters:
@@ -75,6 +89,11 @@ export function hasDiacritic(string: string): boolean {
   return DIACRITIC_REGEX.test(normalizedString);
 }
 
+/**
+ * Helper function to check if a string has one or more emoji in it.
+ *
+ * Under the hood, this uses the same regex check as the Zod library.
+ */
 export function hasEmoji(string: string): boolean {
   return EMOJI_REGEX.test(string);
 }
@@ -107,6 +126,7 @@ export function isSemanticVersion(versionString: string): boolean {
   return match !== null;
 }
 
+/** Helper function to convert a string from kebab-case to camel-case. */
 export function kebabCaseToCamelCase(string: string): string {
   return string.replaceAll(/-./g, (match) => {
     const firstLetterOfWord = match[1];
@@ -154,8 +174,13 @@ export function normalizeString(string: string): string {
  */
 export function parseSemanticVersion(versionString: string):
   | {
+      /** The first number inside of the semantic version. */
       majorVersion: number;
+
+      /** The second number inside of the semantic version. */
       minorVersion: number;
+
+      /** The third number inside of the semantic version. */
       patchVersion: number;
     }
   | undefined {

package/src/functions/tuple.ts

@@ -1,3 +1,9 @@
+/**
+ * Helper functions that have to do with TypeScript tuples.
+ *
+ * @module
+ */
+
 import type { Tuple } from "../types/Tuple.js";
 
 type TupleKey<T extends readonly unknown[]> = {

package/src/functions/types.ts

@@ -1,3 +1,9 @@
+/**
+ * Identity functions that help with narrowing.
+ *
+ * @module
+ */
+
 /**
  * Helper function to narrow an unknown value to an object (i.e. a TypeScript record).
  *

package/src/functions/utils.test.ts

@@ -1,13 +1,7 @@
 import { deepStrictEqual, strictEqual } from "node:assert";
 import test, { describe } from "node:test";
-import {
-  assertDefined,
-  assertNotNull,
-  eRange,
-  iRange,
-  parseFloatSafe,
-  parseIntSafe,
-} from "./utils.js";
+import { assertDefined, assertNotNull } from "./assert.js";
+import { eRange, iRange, parseFloatSafe, parseIntSafe } from "./utils.js";
 
 describe("assertsDefined", () => {
   /** We use a value of null since it is the least arbitrary non-undefined value. */

package/src/functions/utils.ts

@@ -1,45 +1,15 @@
+/**
+ * Helper functions that do not belong to any category in particular.
+ *
+ * @module
+ */
+
 // When regexes are located at the root instead of inside the function, the functions are tested to
 // perform 11% faster.
 
 const FLOAT_REGEX = /^-?\d*\.?\d+$/;
 const INTEGER_REGEX = /^-?\d+$/;
 
-/**
- * Helper function to throw an error if the provided value is equal to `undefined`.
- *
- * This is useful to have TypeScript narrow a `T | undefined` value to `T` in a concise way.
- */
-export function assertDefined<T>(
-  value: T,
-  ...[msg]: [undefined] extends [T]
-    ? [string]
-    : [
-        "The assertion is useless because the provided value does not contain undefined.",
-      ]
-): asserts value is Exclude<T, undefined> {
-  if (value === undefined) {
-    throw new TypeError(msg);
-  }
-}
-
-/**
- * Helper function to throw an error if the provided value is equal to `null`.
- *
- * This is useful to have TypeScript narrow a `T | null` value to `T` in a concise way.
- */
-export 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> {
-  if (value === null) {
-    throw new TypeError(msg);
-  }
-}
-
 /**
  * Helper function to get an iterator of integers with the specified range, inclusive on the lower
  * end and exclusive on the high end. (The "e" in the function name stands for exclusive.) Thus,
@@ -102,7 +72,7 @@ export function* eRange(
  * If you want an array instead of an iterator, use the spread operator like this:
  *
  * ```ts
- * const myArray = [...eRange(1, 3)];
+ * const myArray = [...iRange(1, 3)];
  * ```
  *
  * @param start The integer to start at.

package/src/index.ts

@@ -1,5 +1,6 @@
 export * from "./constants.js";
 export * from "./functions/array.js";
+export * from "./functions/assert.js";
 export * from "./functions/enums.js";
 export * from "./functions/map.js";
 export * from "./functions/math.js";
@@ -11,17 +12,17 @@ export * from "./functions/string.js";
 export * from "./functions/tuple.js";
 export * from "./functions/types.js";
 export * from "./functions/utils.js";
-export * from "./types/AddSubtract.js";
-export * from "./types/CompositionTypeSatisfiesEnum.js";
-export * from "./types/ERange.js";
-export * from "./types/Immutable.js";
-export * from "./types/IRange.js";
-export * from "./types/NaturalNumbersLessThan.js";
-export * from "./types/NaturalNumbersLessThanOrEqualTo.js";
-export * from "./types/ObjectValues.js";
+export type * from "./types/AddSubtract.js";
+export type * from "./types/CompositionTypeSatisfiesEnum.js";
+export type * from "./types/ERange.js";
+export type * from "./types/Immutable.js";
+export type * from "./types/IRange.js";
+export type * from "./types/NaturalNumbersLessThan.js";
+export type * from "./types/NaturalNumbersLessThanOrEqualTo.js";
+export type * from "./types/ObjectValues.js";
 export * from "./types/ReadonlyMap.js";
-export * from "./types/ReadonlyRecord.js";
+export type * from "./types/ReadonlyRecord.js";
 export * from "./types/ReadonlySet.js";
-export * from "./types/Tuple.js";
-export * from "./types/WidenLiteral.js";
-export * from "./types/Writeable.js";
+export type * from "./types/Tuple.js";
+export type * from "./types/WidenLiteral.js";
+export type * from "./types/Writeable.js";

package/src/types/AddSubtract.ts

@@ -1,9 +1,17 @@
-/** From: https://gist.github.com/ryandabler/8b4ff4f36aed47bc09acc03174638468 */
+/**
+ * Helper type to add two other types.
+ *
+ * From: https://gist.github.com/ryandabler/8b4ff4f36aed47bc09acc03174638468
+ */
 export type Add<A extends number, B extends number> = Length<
   [...BuildTuple<A>, ...BuildTuple<B>]
 >;
 
-/** From: https://gist.github.com/ryandabler/8b4ff4f36aed47bc09acc03174638468 */
+/**
+ * Helper type to subtract two other types.
+ *
+ * From: https://gist.github.com/ryandabler/8b4ff4f36aed47bc09acc03174638468
+ */
 export type Subtract<A extends number, B extends number> = A extends A
   ? BuildTuple<A> extends [...infer U, ...BuildTuple<B>]
     ? Length<U>

package/src/types/CompositionTypeSatisfiesEnum.ts

@@ -29,9 +29,11 @@
  * entry for `BazObjective`.
  */
 export type CompositionTypeSatisfiesEnum<
-  T extends { type: unknown },
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  Enum extends T["type"],
+  T extends {
+    /** The type of the discriminated union. */
+    type: unknown;
+  },
+  _Enum extends T["type"],
 > = unknown;
 
 // -----

package/src/types/ObjectValues.ts

@@ -1 +1,2 @@
+/** Helper type to capture just the values of an object/record. */
 export type ObjectValues<T> = T[keyof T];

package/src/types/ReadonlyRecord.ts

@@ -1,3 +1,8 @@
+/**
+ * Helper type to specify that a record should be read-only.
+ *
+ * This is the same thing as `Readonly<Record<K, V>>`.
+ */
 export type ReadonlyRecord<K extends string | number | symbol, V> = Readonly<
   Record<K, V>
 >;

package/src/types/Tuple.ts

@@ -9,6 +9,7 @@ export type Tuple<T, N extends number> = N extends N
     ? T[]
     : _TupleOf<T, N, []>
   : never;
+
 type _TupleOf<T, N extends number, R extends unknown[]> = R["length"] extends N
   ? R
   : _TupleOf<T, N, [T, ...R]>;

package/src/types/WidenLiteral.ts

@@ -1,3 +1,4 @@
+/** Helper type used to widen a const array to the corresponding base type. */
 export type WidenLiteral<T> = T extends string
   ? string
   : T extends number