@xylabs/typeof 5.0.83 → 5.0.86

package/README.md

@@ -15,6 +15,8 @@
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+
+
 ## Reference
 
 **@xylabs/typeof**
@@ -23,64 +25,68 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Type Aliases
 
-- [Brand](#type-aliases/Brand)
-- [IdentityFunction](#type-aliases/IdentityFunction)
-- [FieldType](#type-aliases/FieldType)
-- [ObjectTypeShape](#type-aliases/ObjectTypeShape)
-- [TypeOfTypes](#type-aliases/TypeOfTypes)
-- [TypedValue](#type-aliases/TypedValue)
-- [TypedKey](#type-aliases/TypedKey)
-- [TypedObject](#type-aliases/TypedObject)
-- [TypedArray](#type-aliases/TypedArray)
-- [AnyFunction](#type-aliases/AnyFunction)
-- [RecordKey](#type-aliases/RecordKey)
+| Type Alias | Description |
+| ------ | ------ |
+| [Brand](#type-aliases/Brand) | Creates a branded type by intersecting base type T with brand type B, enabling nominal typing in TypeScript. |
+| [IdentityFunction](#type-aliases/IdentityFunction) | A type guard function that narrows an unknown value to type T. |
+| [FieldType](#type-aliases/FieldType) | Union of string literals representing the possible types of an object field. |
+| [ObjectTypeShape](#type-aliases/ObjectTypeShape) | Describes the expected shape of an object by mapping each key to its expected field type. |
+| [TypeOfTypes](#type-aliases/TypeOfTypes) | Union of string literals representing the possible results of the extended `typeOf` function. |
+| [TypedValue](#type-aliases/TypedValue) | A value that can appear in a typed object tree (primitives, objects, arrays, functions, and symbols). |
+| [TypedKey](#type-aliases/TypedKey) | A valid key for a typed object. Defaults to string | number | symbol unless narrowed by T. |
+| [TypedObject](#type-aliases/TypedObject) | An object whose keys are TypedKey and whose values are TypedValue. |
+| [TypedArray](#type-aliases/TypedArray) | An array of TypedValue elements. |
+| [AnyFunction](#type-aliases/AnyFunction) | A function type that accepts any arguments and returns unknown. |
+| [RecordKey](#type-aliases/RecordKey) | A union of valid object key types. |
 
 ## Functions
 
-- [isTypedKey](#functions/isTypedKey)
-- [isTypedValue](#functions/isTypedValue)
-- [isTypedArray](#functions/isTypedArray)
-- [isValidTypedFieldPair](#functions/isValidTypedFieldPair)
-- [isTypedObject](#functions/isTypedObject)
-- [ifDefined](#functions/ifDefined)
-- [ifTypeOf](#functions/ifTypeOf)
-- [isUndefined](#functions/isUndefined)
-- [isDefined](#functions/isDefined)
-- [isNull](#functions/isNull)
-- [isDefinedNotNull](#functions/isDefinedNotNull)
-- [isUndefinedOrNull](#functions/isUndefinedOrNull)
-- [isBigInt](#functions/isBigInt)
-- [isString](#functions/isString)
-- [isNumber](#functions/isNumber)
-- [isObject](#functions/isObject)
-- [isArray](#functions/isArray)
-- [isFunction](#functions/isFunction)
-- [isSymbol](#functions/isSymbol)
-- [isEmptyObject](#functions/isEmptyObject)
-- [isEmptyString](#functions/isEmptyString)
-- [isEmptyArray](#functions/isEmptyArray)
-- [isPopulatedArray](#functions/isPopulatedArray)
-- [isEmpty](#functions/isEmpty)
-- [isFalsy](#functions/isFalsy)
-- [isTruthy](#functions/isTruthy)
-- [isBoolean](#functions/isBoolean)
-- [isDateString](#functions/isDateString)
-- [isDate](#functions/isDate)
-- [isRegExp](#functions/isRegExp)
-- [isError](#functions/isError)
-- [isPromise](#functions/isPromise)
-- [isPromiseLike](#functions/isPromiseLike)
-- [isMap](#functions/isMap)
-- [isArrayBufferView](#functions/isArrayBufferView)
-- [isSet](#functions/isSet)
-- [isWeakMap](#functions/isWeakMap)
-- [isWeakSet](#functions/isWeakSet)
-- [isDataView](#functions/isDataView)
-- [isBlob](#functions/isBlob)
-- [isFile](#functions/isFile)
-- [isType](#functions/isType)
-- [typeOf](#functions/typeOf)
-- [validateType](#functions/validateType)
+| Function | Description |
+| ------ | ------ |
+| [isTypedKey](#functions/isTypedKey) | Type guard that checks whether a value is a valid TypedKey (string, bigint, number, or symbol). |
+| [isTypedValue](#functions/isTypedValue) | Type guard that checks whether a value is a valid TypedValue. |
+| [isTypedArray](#functions/isTypedArray) | Type guard that checks whether a value is a TypedArray (an array where every element is a TypedValue). |
+| [isValidTypedFieldPair](#functions/isValidTypedFieldPair) | Type guard that checks whether a key-value pair has a valid TypedKey and TypedValue. |
+| [isTypedObject](#functions/isTypedObject) | Type guard that checks whether a value is a TypedObject (an object with TypedKey keys and TypedValue values). |
+| [ifDefined](#functions/ifDefined) | Invokes the callback only if the value is neither null nor undefined. |
+| [ifTypeOf](#functions/ifTypeOf) | Invokes the callback if the value matches the specified type, with an optional additional predicate. |
+| [isUndefined](#functions/isUndefined) | Type guard that checks whether a value is undefined. |
+| [isDefined](#functions/isDefined) | Type guard that checks whether a value is not undefined. |
+| [isNull](#functions/isNull) | Type guard that checks whether a value is null. |
+| [isDefinedNotNull](#functions/isDefinedNotNull) | Type guard that checks whether a value is neither undefined nor null. |
+| [isUndefinedOrNull](#functions/isUndefinedOrNull) | Type guard that checks whether a value is undefined or null. |
+| [isBigInt](#functions/isBigInt) | Type guard that checks whether a value is a bigint. |
+| [isString](#functions/isString) | Type guard that checks whether a value is a string. |
+| [isNumber](#functions/isNumber) | Type guard that checks whether a value is a number. |
+| [isObject](#functions/isObject) | Type guard that checks whether a value is a plain object (not null and not an array). |
+| [isArray](#functions/isArray) | Type guard that checks whether a value is an array. |
+| [isFunction](#functions/isFunction) | Type guard that checks whether a value is a function. |
+| [isSymbol](#functions/isSymbol) | Type guard that checks whether a value is a symbol. |
+| [isEmptyObject](#functions/isEmptyObject) | Type guard that checks whether a value is an object with no own keys. |
+| [isEmptyString](#functions/isEmptyString) | Type guard that checks whether a value is an empty string. |
+| [isEmptyArray](#functions/isEmptyArray) | Type guard that checks whether a value is an empty array. |
+| [isPopulatedArray](#functions/isPopulatedArray) | Type guard that checks whether a value is a non-empty array. |
+| [isEmpty](#functions/isEmpty) | Type guard that checks whether a value is empty (empty string, empty array, or empty object). |
+| [isFalsy](#functions/isFalsy) | Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n). |
+| [isTruthy](#functions/isTruthy) | Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n). |
+| [isBoolean](#functions/isBoolean) | Type guard that checks whether a value is a boolean. |
+| [isDateString](#functions/isDateString) | Type guard that checks whether a value is a string that can be parsed as a valid date. |
+| [isDate](#functions/isDate) | Type guard that checks whether a value is a Date instance. |
+| [isRegExp](#functions/isRegExp) | Type guard that checks whether a value is a RegExp instance. |
+| [isError](#functions/isError) | Type guard that checks whether a value is an Error instance. |
+| [isPromise](#functions/isPromise) | Type guard that checks whether a value is a Promise instance. |
+| [isPromiseLike](#functions/isPromiseLike) | Type guard that checks whether a value is promise-like (has a `then` method). |
+| [isMap](#functions/isMap) | Type guard that checks whether a value is a Map instance. |
+| [isArrayBufferView](#functions/isArrayBufferView) | Type guard that checks whether a value is an ArrayBufferView (e.g., TypedArray or DataView). |
+| [isSet](#functions/isSet) | Type guard that checks whether a value is a Set instance. |
+| [isWeakMap](#functions/isWeakMap) | Type guard that checks whether a value is a WeakMap instance. |
+| [isWeakSet](#functions/isWeakSet) | Type guard that checks whether a value is a WeakSet instance. |
+| [isDataView](#functions/isDataView) | Type guard that checks whether a value is a DataView instance. |
+| [isBlob](#functions/isBlob) | Type guard that checks whether a value is a Blob instance. |
+| [isFile](#functions/isFile) | Type guard that checks whether a value is a File instance. |
+| [isType](#functions/isType) | Checks whether a value matches the expected field type, with correct handling for arrays and nulls. |
+| [typeOf](#functions/typeOf) | Extended typeof that distinguishes arrays from objects (unlike native `typeof`). |
+| [validateType](#functions/validateType) | Validates that a value matches the expected type, returning the value and any errors. |
 
 ### functions
 
@@ -91,29 +97,30 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 ***
 
 ```ts
-function ifDefined<T>(value, func): T | undefined;
+function ifDefined<T>(value: T, func: (value: T) => void): T | undefined;
 ```
 
-## Type Parameters
+Invokes the callback only if the value is neither null nor undefined.
 
-### T
+## Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ## Parameters
 
-### value
-
-`T`
-
-### func
-
-(`value`) => `void`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `T` | The value to check. |
+| `func` | (`value`: `T`) => `void` | The callback to invoke with the value if it is defined. |
 
 ## Returns
 
 `T` \| `undefined`
 
+The value if defined, or undefined otherwise.
+
   ### <a id="ifTypeOf"></a>ifTypeOf
 
 [**@xylabs/typeof**](#../README)
@@ -122,44 +129,36 @@ function ifDefined<T>(value, func): T | undefined;
 
 ```ts
 function ifTypeOf<T, R>(
-   typeName, 
-   value, 
-   trueFunc, 
-   isFunc?): R | undefined;
+   typeName: TypeOfTypes, 
+   value: unknown, 
+   trueFunc: (value: T) => R, 
+   isFunc?: (value: T) => boolean): R | undefined;
 ```
 
-## Type Parameters
-
-### T
-
-`T`
+Invokes the callback if the value matches the specified type, with an optional additional predicate.
 
-### R
+## Type Parameters
 
-`R`
+| Type Parameter |
+| ------ |
+| `T` |
+| `R` |
 
 ## Parameters
 
-### typeName
-
-[`TypeOfTypes`](#../type-aliases/TypeOfTypes)
-
-### value
-
-`unknown`
-
-### trueFunc
-
-(`value`) => `R`
-
-### isFunc?
-
-(`value`) => `boolean`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `typeName` | [`TypeOfTypes`](#../type-aliases/TypeOfTypes) | The expected type name to match against. |
+| `value` | `unknown` | The value to check. |
+| `trueFunc` | (`value`: `T`) => `R` | The callback to invoke if the type matches. |
+| `isFunc?` | (`value`: `T`) => `boolean` | Optional additional predicate that must also return true. |
 
 ## Returns
 
 `R` \| `undefined`
 
+The result of trueFunc if the type matches (and isFunc passes), or undefined.
+
   ### <a id="isArray"></a>isArray
 
 [**@xylabs/typeof**](#../README)
@@ -169,14 +168,16 @@ function ifTypeOf<T, R>(
 ## Call Signature
 
 ```ts
-function isArray(value): value is readonly unknown[];
+function isArray(value: unknown): value is readonly unknown[];
 ```
 
-### Parameters
+Type guard that checks whether a value is an array.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -185,20 +186,22 @@ function isArray(value): value is readonly unknown[];
 ## Call Signature
 
 ```ts
-function isArray<T>(value): value is Extract<T, readonly unknown[]>;
+function isArray<T>(value: T): value is Extract<T, readonly unknown[]>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is an array.
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -213,14 +216,16 @@ function isArray<T>(value): value is Extract<T, readonly unknown[]>;
 ## Call Signature
 
 ```ts
-function isArrayBufferView(value): value is ArrayBufferView<ArrayBufferLike>;
+function isArrayBufferView(value: unknown): value is ArrayBufferView<ArrayBufferLike>;
 ```
 
+Type guard that checks whether a value is an ArrayBufferView (e.g., TypedArray or DataView).
+
 ### Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -229,20 +234,22 @@ function isArrayBufferView(value): value is ArrayBufferView<ArrayBufferLike>;
 ## Call Signature
 
 ```ts
-function isArrayBufferView<T>(value): value is Extract<T, ArrayBufferView<ArrayBufferLike>>;
+function isArrayBufferView<T>(value: T): value is Extract<T, ArrayBufferView<ArrayBufferLike>>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is an ArrayBufferView (e.g., TypedArray or DataView).
 
-### T
+### Type Parameters
 
-`T` *extends* `ArrayBufferView`\<`ArrayBufferLike`\>
+| Type Parameter |
+| ------ |
+| `T` *extends* `ArrayBufferView`\<`ArrayBufferLike`\> |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -257,14 +264,16 @@ function isArrayBufferView<T>(value): value is Extract<T, ArrayBufferView<ArrayB
 ## Call Signature
 
 ```ts
-function isBigInt(value): value is bigint;
+function isBigInt(value: unknown): value is bigint;
 ```
 
-### Parameters
+Type guard that checks whether a value is a bigint.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -273,20 +282,22 @@ function isBigInt(value): value is bigint;
 ## Call Signature
 
 ```ts
-function isBigInt<T>(value): value is Extract<T, bigint>;
+function isBigInt<T>(value: T): value is Extract<T, bigint>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a bigint.
 
-### T
+### Type Parameters
 
-`T` *extends* `bigint`
+| Type Parameter |
+| ------ |
+| `T` *extends* `bigint` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -301,14 +312,16 @@ function isBigInt<T>(value): value is Extract<T, bigint>;
 ## Call Signature
 
 ```ts
-function isBlob(value): value is Blob;
+function isBlob(value: unknown): value is Blob;
 ```
 
+Type guard that checks whether a value is a Blob instance.
+
 ### Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -317,20 +330,22 @@ function isBlob(value): value is Blob;
 ## Call Signature
 
 ```ts
-function isBlob<T>(value): value is Extract<T, Blob>;
+function isBlob<T>(value: T): value is Extract<T, Blob>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a Blob instance.
 
-### T
+### Type Parameters
 
-`T` *extends* `Blob`
+| Type Parameter |
+| ------ |
+| `T` *extends* `Blob` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -345,14 +360,16 @@ function isBlob<T>(value): value is Extract<T, Blob>;
 ## Call Signature
 
 ```ts
-function isBoolean(value): value is boolean;
+function isBoolean(value: unknown): value is boolean;
 ```
 
+Type guard that checks whether a value is a boolean.
+
 ### Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -361,20 +378,22 @@ function isBoolean(value): value is boolean;
 ## Call Signature
 
 ```ts
-function isBoolean<T>(value): value is Extract<T, boolean>;
+function isBoolean<T>(value: T): value is Extract<T, boolean>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a boolean.
 
-### T
+### Type Parameters
 
-`T` *extends* `boolean`
+| Type Parameter |
+| ------ |
+| `T` *extends* `boolean` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -389,14 +408,16 @@ function isBoolean<T>(value): value is Extract<T, boolean>;
 ## Call Signature
 
 ```ts
-function isDataView(value): value is DataView<ArrayBufferLike>;
+function isDataView(value: unknown): value is DataView<ArrayBufferLike>;
 ```
 
-### Parameters
+Type guard that checks whether a value is a DataView instance.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -405,20 +426,22 @@ function isDataView(value): value is DataView<ArrayBufferLike>;
 ## Call Signature
 
 ```ts
-function isDataView<T>(value): value is Extract<T, DataView<ArrayBufferLike>>;
+function isDataView<T>(value: T): value is Extract<T, DataView<ArrayBufferLike>>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a DataView instance.
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -433,14 +456,16 @@ function isDataView<T>(value): value is Extract<T, DataView<ArrayBufferLike>>;
 ## Call Signature
 
 ```ts
-function isDate(value): value is Date;
+function isDate(value: unknown): value is Date;
 ```
 
-### Parameters
+Type guard that checks whether a value is a Date instance.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -449,20 +474,22 @@ function isDate(value): value is Date;
 ## Call Signature
 
 ```ts
-function isDate<T>(value): value is Extract<T, Date>;
+function isDate<T>(value: T): value is Extract<T, Date>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a Date instance.
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -477,14 +504,16 @@ function isDate<T>(value): value is Extract<T, Date>;
 ## Call Signature
 
 ```ts
-function isDateString(value): value is string;
+function isDateString(value: unknown): value is string;
 ```
 
+Type guard that checks whether a value is a string that can be parsed as a valid date.
+
 ### Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -493,20 +522,22 @@ function isDateString(value): value is string;
 ## Call Signature
 
 ```ts
-function isDateString<T>(value): value is Extract<T, string>;
+function isDateString<T>(value: T): value is Extract<T, string>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a string that can be parsed as a valid date.
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -519,20 +550,22 @@ function isDateString<T>(value): value is Extract<T, string>;
 ***
 
 ```ts
-function isDefined<T>(value): value is Exclude<T, undefined>;
+function isDefined<T>(value: T): value is Exclude<T, undefined>;
 ```
 
-## Type Parameters
+Type guard that checks whether a value is not undefined.
 
-### T
+## Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ## Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ## Returns
 
@@ -545,20 +578,22 @@ function isDefined<T>(value): value is Exclude<T, undefined>;
 ***
 
 ```ts
-function isDefinedNotNull<T>(value): value is Exclude<T, null | undefined>;
+function isDefinedNotNull<T>(value: T): value is Exclude<T, null | undefined>;
 ```
 
-## Type Parameters
+Type guard that checks whether a value is neither undefined nor null.
 
-### T
+## Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ## Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ## Returns
 
@@ -573,20 +608,22 @@ value is Exclude\<T, null \| undefined\>
 ## Call Signature
 
 ```ts
-function isEmpty<T>(value): value is T;
+function isEmpty<T>(value: unknown): value is T;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is empty (empty string, empty array, or empty object).
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -595,28 +632,24 @@ function isEmpty<T>(value): value is T;
 ## Call Signature
 
 ```ts
-function isEmpty<K, V, T>(value): value is Extract<T, Record<K, never>>;
+function isEmpty<K, V, T>(value: T): value is Extract<T, Record<K, never>>;
 ```
 
-### Type Parameters
-
-### K
-
-`K` *extends* [`RecordKey`](#../type-aliases/RecordKey)
+Type guard that checks whether a value is empty (empty string, empty array, or empty object).
 
-### V
-
-`V`
-
-### T
+### Type Parameters
 
-`T` *extends* `Record`\<`K`, `V`\>
+| Type Parameter |
+| ------ |
+| `K` *extends* [`RecordKey`](#../type-aliases/RecordKey) |
+| `V` |
+| `T` *extends* `Record`\<`K`, `V`\> |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -625,20 +658,22 @@ function isEmpty<K, V, T>(value): value is Extract<T, Record<K, never>>;
 ## Call Signature
 
 ```ts
-function isEmpty<T>(value): value is Extract<T, never[]>;
+function isEmpty<T>(value: T): value is Extract<T, never[]>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is empty (empty string, empty array, or empty object).
 
-### T
+### Type Parameters
 
-`T` *extends* `unknown`[]
+| Type Parameter |
+| ------ |
+| `T` *extends* `unknown`[] |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -653,14 +688,16 @@ function isEmpty<T>(value): value is Extract<T, never[]>;
 ## Call Signature
 
 ```ts
-function isEmptyArray(value): value is [];
+function isEmptyArray(value: unknown): value is [];
 ```
 
+Type guard that checks whether a value is an empty array.
+
 ### Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -669,20 +706,22 @@ function isEmptyArray(value): value is [];
 ## Call Signature
 
 ```ts
-function isEmptyArray<T>(value): value is Extract<T, unknown[]>;
+function isEmptyArray<T>(value: T): value is Extract<T, unknown[]>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is an empty array.
 
-### T
+### Type Parameters
 
-`T` *extends* `unknown`[]
+| Type Parameter |
+| ------ |
+| `T` *extends* `unknown`[] |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -697,14 +736,16 @@ function isEmptyArray<T>(value): value is Extract<T, unknown[]>;
 ## Call Signature
 
 ```ts
-function isEmptyObject(value): value is {};
+function isEmptyObject(value: unknown): value is {};
 ```
 
-### Parameters
+Type guard that checks whether a value is an object with no own keys.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -713,28 +754,24 @@ function isEmptyObject(value): value is {};
 ## Call Signature
 
 ```ts
-function isEmptyObject<K, V, T>(value): value is Extract<T, Record<K, never>>;
+function isEmptyObject<K, V, T>(value: T): value is Extract<T, Record<K, never>>;
 ```
 
-### Type Parameters
-
-### K
-
-`K` *extends* [`RecordKey`](#../type-aliases/RecordKey)
-
-### V
-
-`V`
+Type guard that checks whether a value is an object with no own keys.
 
-### T
+### Type Parameters
 
-`T` *extends* `Record`\<`K`, `V`\>
+| Type Parameter |
+| ------ |
+| `K` *extends* [`RecordKey`](#../type-aliases/RecordKey) |
+| `V` |
+| `T` *extends* `Record`\<`K`, `V`\> |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -749,14 +786,16 @@ function isEmptyObject<K, V, T>(value): value is Extract<T, Record<K, never>>;
 ## Call Signature
 
 ```ts
-function isEmptyString(value): value is "";
+function isEmptyString(value: unknown): value is "";
 ```
 
-### Parameters
+Type guard that checks whether a value is an empty string.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -765,20 +804,22 @@ function isEmptyString(value): value is "";
 ## Call Signature
 
 ```ts
-function isEmptyString<T>(value): value is Extract<T, "">;
+function isEmptyString<T>(value: T): value is Extract<T, "">;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is an empty string.
 
-### T
+### Type Parameters
 
-`T` *extends* `string`
+| Type Parameter |
+| ------ |
+| `T` *extends* `string` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -793,14 +834,16 @@ function isEmptyString<T>(value): value is Extract<T, "">;
 ## Call Signature
 
 ```ts
-function isError(value): value is Error;
+function isError(value: unknown): value is Error;
 ```
 
-### Parameters
+Type guard that checks whether a value is an Error instance.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -809,20 +852,22 @@ function isError(value): value is Error;
 ## Call Signature
 
 ```ts
-function isError<T>(value): value is Extract<T, Error>;
+function isError<T>(value: T): value is Extract<T, Error>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is an Error instance.
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -837,20 +882,22 @@ function isError<T>(value): value is Extract<T, Error>;
 ## Call Signature
 
 ```ts
-function isFalsy<T>(value): value is Extract<T, false | "" | 0 | 0n | null | undefined>;
+function isFalsy<T>(value: T): value is Extract<T, false | "" | 0 | 0n | null | undefined>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -859,20 +906,22 @@ value is Extract\<T, false \| "" \| 0 \| 0n \| null \| undefined\>
 ## Call Signature
 
 ```ts
-function isFalsy<T>(value): value is Extract<T, false>;
+function isFalsy<T>(value: T): value is Extract<T, false>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T` *extends* `boolean`
+| Type Parameter |
+| ------ |
+| `T` *extends* `boolean` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -881,20 +930,22 @@ function isFalsy<T>(value): value is Extract<T, false>;
 ## Call Signature
 
 ```ts
-function isFalsy<T>(value): value is Extract<T, 0>;
+function isFalsy<T>(value: T): value is Extract<T, 0>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T` *extends* `number`
+| Type Parameter |
+| ------ |
+| `T` *extends* `number` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -903,20 +954,22 @@ function isFalsy<T>(value): value is Extract<T, 0>;
 ## Call Signature
 
 ```ts
-function isFalsy<T>(value): value is Extract<T, 0n>;
+function isFalsy<T>(value: T): value is Extract<T, 0n>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T` *extends* `bigint`
+| Type Parameter |
+| ------ |
+| `T` *extends* `bigint` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -925,20 +978,22 @@ function isFalsy<T>(value): value is Extract<T, 0n>;
 ## Call Signature
 
 ```ts
-function isFalsy<T>(value): value is Extract<T, null>;
+function isFalsy<T>(value: T): value is Extract<T, null>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T` *extends* `null`
+| Type Parameter |
+| ------ |
+| `T` *extends* `null` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -947,20 +1002,22 @@ function isFalsy<T>(value): value is Extract<T, null>;
 ## Call Signature
 
 ```ts
-function isFalsy<T>(value): value is Extract<T, undefined>;
+function isFalsy<T>(value: T): value is Extract<T, undefined>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T` *extends* `undefined`
+| Type Parameter |
+| ------ |
+| `T` *extends* `undefined` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -969,20 +1026,22 @@ function isFalsy<T>(value): value is Extract<T, undefined>;
 ## Call Signature
 
 ```ts
-function isFalsy<T>(value): value is Extract<T, "">;
+function isFalsy<T>(value: T): value is Extract<T, "">;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T` *extends* `string`
+| Type Parameter |
+| ------ |
+| `T` *extends* `string` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -997,14 +1056,16 @@ function isFalsy<T>(value): value is Extract<T, "">;
 ## Call Signature
 
 ```ts
-function isFile(value): value is File;
+function isFile(value: unknown): value is File;
 ```
 
-### Parameters
+Type guard that checks whether a value is a File instance.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1013,20 +1074,22 @@ function isFile(value): value is File;
 ## Call Signature
 
 ```ts
-function isFile<T>(value): value is Extract<T, File>;
+function isFile<T>(value: T): value is Extract<T, File>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a File instance.
 
-### T
+### Type Parameters
 
-`T` *extends* `File`
+| Type Parameter |
+| ------ |
+| `T` *extends* `File` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1041,14 +1104,16 @@ function isFile<T>(value): value is Extract<T, File>;
 ## Call Signature
 
 ```ts
-function isFunction(value): value is AnyFunction;
+function isFunction(value: unknown): value is AnyFunction;
 ```
 
-### Parameters
+Type guard that checks whether a value is a function.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1057,20 +1122,22 @@ function isFunction(value): value is AnyFunction;
 ## Call Signature
 
 ```ts
-function isFunction<T>(value): value is Extract<T, AnyFunction>;
+function isFunction<T>(value: T): value is Extract<T, AnyFunction>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a function.
 
-### T
+### Type Parameters
 
-`T` *extends* [`AnyFunction`](#../type-aliases/AnyFunction)
+| Type Parameter |
+| ------ |
+| `T` *extends* [`AnyFunction`](#../type-aliases/AnyFunction) |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1085,14 +1152,16 @@ function isFunction<T>(value): value is Extract<T, AnyFunction>;
 ## Call Signature
 
 ```ts
-function isMap(value): value is Map<unknown, unknown>;
+function isMap(value: unknown): value is Map<unknown, unknown>;
 ```
 
+Type guard that checks whether a value is a Map instance.
+
 ### Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1101,28 +1170,24 @@ function isMap(value): value is Map<unknown, unknown>;
 ## Call Signature
 
 ```ts
-function isMap<K, V, T>(value): value is Extract<T, Map<K, V>>;
+function isMap<K, V, T>(value: T): value is Extract<T, Map<K, V>>;
 ```
 
-### Type Parameters
-
-### K
-
-`K`
-
-### V
+Type guard that checks whether a value is a Map instance.
 
-`V`
-
-### T
+### Type Parameters
 
-`T` *extends* `Map`\<`K`, `V`\>
+| Type Parameter |
+| ------ |
+| `K` |
+| `V` |
+| `T` *extends* `Map`\<`K`, `V`\> |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1137,14 +1202,16 @@ function isMap<K, V, T>(value): value is Extract<T, Map<K, V>>;
 ## Call Signature
 
 ```ts
-function isNull(value): value is null;
+function isNull(value: unknown): value is null;
 ```
 
+Type guard that checks whether a value is null.
+
 ### Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1153,20 +1220,22 @@ function isNull(value): value is null;
 ## Call Signature
 
 ```ts
-function isNull<T>(value): value is Extract<T, null>;
+function isNull<T>(value: T): value is Extract<T, null>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is null.
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1181,14 +1250,16 @@ function isNull<T>(value): value is Extract<T, null>;
 ## Call Signature
 
 ```ts
-function isNumber(value): value is number;
+function isNumber(value: unknown): value is number;
 ```
 
-### Parameters
+Type guard that checks whether a value is a number.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1197,20 +1268,22 @@ function isNumber(value): value is number;
 ## Call Signature
 
 ```ts
-function isNumber<T>(value): value is Extract<T, number>;
+function isNumber<T>(value: T): value is Extract<T, number>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a number.
 
-### T
+### Type Parameters
 
-`T` *extends* `number`
+| Type Parameter |
+| ------ |
+| `T` *extends* `number` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1225,14 +1298,16 @@ function isNumber<T>(value): value is Extract<T, number>;
 ## Call Signature
 
 ```ts
-function isObject(value): value is object;
+function isObject(value: unknown): value is object;
 ```
 
-### Parameters
+Type guard that checks whether a value is a plain object (not null and not an array).
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1241,20 +1316,22 @@ function isObject(value): value is object;
 ## Call Signature
 
 ```ts
-function isObject<T>(value): value is Extract<T, object>;
+function isObject<T>(value: T): value is Extract<T, object>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a plain object (not null and not an array).
 
-### T
+### Type Parameters
 
-`T` *extends* `object`
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1269,14 +1346,16 @@ function isObject<T>(value): value is Extract<T, object>;
 ## Call Signature
 
 ```ts
-function isPopulatedArray(value): value is readonly unknown[];
+function isPopulatedArray(value: unknown): value is readonly unknown[];
 ```
 
-### Parameters
+Type guard that checks whether a value is a non-empty array.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1285,20 +1364,22 @@ function isPopulatedArray(value): value is readonly unknown[];
 ## Call Signature
 
 ```ts
-function isPopulatedArray<T>(value): value is Extract<T, readonly unknown[]>;
+function isPopulatedArray<T>(value: T): value is Extract<T, readonly unknown[]>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a non-empty array.
 
-### T
+### Type Parameters
 
-`T` *extends* `unknown`[]
+| Type Parameter |
+| ------ |
+| `T` *extends* `unknown`[] |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1313,14 +1394,16 @@ function isPopulatedArray<T>(value): value is Extract<T, readonly unknown[]>;
 ## Call Signature
 
 ```ts
-function isPromise(value): value is Promise<unknown>;
+function isPromise(value: unknown): value is Promise<unknown>;
 ```
 
-### Parameters
+Type guard that checks whether a value is a Promise instance.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1329,20 +1412,22 @@ function isPromise(value): value is Promise<unknown>;
 ## Call Signature
 
 ```ts
-function isPromise<T>(value): value is Extract<T, Promise<unknown>>;
+function isPromise<T>(value: T): value is Extract<T, Promise<unknown>>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a Promise instance.
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1357,14 +1442,16 @@ function isPromise<T>(value): value is Extract<T, Promise<unknown>>;
 ## Call Signature
 
 ```ts
-function isPromiseLike(value): value is Promise<unknown>;
+function isPromiseLike(value: unknown): value is Promise<unknown>;
 ```
 
-### Parameters
+Type guard that checks whether a value is promise-like (has a `then` method).
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1373,20 +1460,22 @@ function isPromiseLike(value): value is Promise<unknown>;
 ## Call Signature
 
 ```ts
-function isPromiseLike<T>(value): value is Extract<T, Promise<unknown>>;
+function isPromiseLike<T>(value: T): value is Extract<T, Promise<unknown>>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is promise-like (has a `then` method).
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1401,14 +1490,16 @@ function isPromiseLike<T>(value): value is Extract<T, Promise<unknown>>;
 ## Call Signature
 
 ```ts
-function isRegExp(value): value is RegExp;
+function isRegExp(value: unknown): value is RegExp;
 ```
 
-### Parameters
+Type guard that checks whether a value is a RegExp instance.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1417,20 +1508,22 @@ function isRegExp(value): value is RegExp;
 ## Call Signature
 
 ```ts
-function isRegExp<T>(value): value is Extract<T, RegExp>;
+function isRegExp<T>(value: T): value is Extract<T, RegExp>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a RegExp instance.
 
-### T
+### Type Parameters
 
-`T` *extends* `RegExp`
+| Type Parameter |
+| ------ |
+| `T` *extends* `RegExp` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1445,14 +1538,16 @@ function isRegExp<T>(value): value is Extract<T, RegExp>;
 ## Call Signature
 
 ```ts
-function isSet(value): value is Set<unknown>;
+function isSet(value: unknown): value is Set<unknown>;
 ```
 
+Type guard that checks whether a value is a Set instance.
+
 ### Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1461,20 +1556,22 @@ function isSet(value): value is Set<unknown>;
 ## Call Signature
 
 ```ts
-function isSet<T>(value): value is Extract<T, Set<unknown>>;
+function isSet<T>(value: unknown): value is Extract<T, Set<unknown>>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a Set instance.
 
-### T
+### Type Parameters
 
-`T` *extends* `Set`\<`unknown`\>
+| Type Parameter |
+| ------ |
+| `T` *extends* `Set`\<`unknown`\> |
 
 ### Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1489,14 +1586,16 @@ function isSet<T>(value): value is Extract<T, Set<unknown>>;
 ## Call Signature
 
 ```ts
-function isString(value): value is string;
+function isString(value: unknown): value is string;
 ```
 
-### Parameters
+Type guard that checks whether a value is a string.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1505,20 +1604,22 @@ function isString(value): value is string;
 ## Call Signature
 
 ```ts
-function isString<T>(value): value is Extract<T, string>;
+function isString<T>(value: T): value is Extract<T, string>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a string.
 
-### T
+### Type Parameters
 
-`T` *extends* `string`
+| Type Parameter |
+| ------ |
+| `T` *extends* `string` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1533,14 +1634,16 @@ function isString<T>(value): value is Extract<T, string>;
 ## Call Signature
 
 ```ts
-function isSymbol(value): value is symbol;
+function isSymbol(value: unknown): value is symbol;
 ```
 
+Type guard that checks whether a value is a symbol.
+
 ### Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1549,20 +1652,22 @@ function isSymbol(value): value is symbol;
 ## Call Signature
 
 ```ts
-function isSymbol<T>(value): value is Extract<T, symbol>;
+function isSymbol<T>(value: T): value is Extract<T, symbol>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is a symbol.
 
-### T
+### Type Parameters
 
-`T` *extends* `symbol`
+| Type Parameter |
+| ------ |
+| `T` *extends* `symbol` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1577,20 +1682,22 @@ function isSymbol<T>(value): value is Extract<T, symbol>;
 ## Call Signature
 
 ```ts
-function isTruthy<T>(value): value is Exclude<T, false | "" | 0 | 0n | null | undefined>;
+function isTruthy<T>(value: T): value is Exclude<T, false | "" | 0 | 0n | null | undefined>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1599,20 +1706,22 @@ value is Exclude\<T, false \| "" \| 0 \| 0n \| null \| undefined\>
 ## Call Signature
 
 ```ts
-function isTruthy<T>(value): value is Extract<T, true>;
+function isTruthy<T>(value: T): value is Extract<T, true>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T` *extends* `boolean`
+| Type Parameter |
+| ------ |
+| `T` *extends* `boolean` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1621,20 +1730,22 @@ function isTruthy<T>(value): value is Extract<T, true>;
 ## Call Signature
 
 ```ts
-function isTruthy<T>(value): value is Extract<T, number>;
+function isTruthy<T>(value: T): value is Extract<T, number>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T` *extends* `number`
+| Type Parameter |
+| ------ |
+| `T` *extends* `number` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1643,20 +1754,22 @@ function isTruthy<T>(value): value is Extract<T, number>;
 ## Call Signature
 
 ```ts
-function isTruthy<T>(value): value is Extract<T, bigint>;
+function isTruthy<T>(value: T): value is Extract<T, bigint>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T` *extends* `bigint`
+| Type Parameter |
+| ------ |
+| `T` *extends* `bigint` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1665,20 +1778,22 @@ function isTruthy<T>(value): value is Extract<T, bigint>;
 ## Call Signature
 
 ```ts
-function isTruthy<T>(value): value is Extract<T, null>;
+function isTruthy<T>(value: T): value is Extract<T, null>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T` *extends* `null`
+| Type Parameter |
+| ------ |
+| `T` *extends* `null` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1687,20 +1802,22 @@ function isTruthy<T>(value): value is Extract<T, null>;
 ## Call Signature
 
 ```ts
-function isTruthy<T>(value): value is Extract<T, undefined>;
+function isTruthy<T>(value: T): value is Extract<T, undefined>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T` *extends* `undefined`
+| Type Parameter |
+| ------ |
+| `T` *extends* `undefined` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1709,20 +1826,22 @@ function isTruthy<T>(value): value is Extract<T, undefined>;
 ## Call Signature
 
 ```ts
-function isTruthy<T>(value): value is Extract<T, string>;
+function isTruthy<T>(value: T): value is Extract<T, string>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
 
-### T
+### Type Parameters
 
-`T` *extends* `string`
+| Type Parameter |
+| ------ |
+| `T` *extends* `string` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1735,23 +1854,24 @@ function isTruthy<T>(value): value is Extract<T, string>;
 ***
 
 ```ts
-function isType(value, expectedType): boolean;
+function isType(value: unknown, expectedType: FieldType): boolean;
 ```
 
-## Parameters
-
-### value
+Checks whether a value matches the expected field type, with correct handling for arrays and nulls.
 
-`unknown`
-
-### expectedType
+## Parameters
 
-[`FieldType`](#../type-aliases/FieldType)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to check. |
+| `expectedType` | [`FieldType`](#../type-aliases/FieldType) | The expected type string. |
 
 ## Returns
 
 `boolean`
 
+True if the value matches the expected type.
+
   ### <a id="isTypedArray"></a>isTypedArray
 
 [**@xylabs/typeof**](#../README)
@@ -1759,19 +1879,23 @@ function isType(value, expectedType): boolean;
 ***
 
 ```ts
-function isTypedArray(value): value is TypedArray;
+function isTypedArray(value: unknown): value is TypedArray;
 ```
 
-## Parameters
+Type guard that checks whether a value is a TypedArray (an array where every element is a TypedValue).
 
-### value
+## Parameters
 
-`unknown`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to check. |
 
 ## Returns
 
 `value is TypedArray`
 
+True if the value is an array of TypedValue elements.
+
   ### <a id="isTypedKey"></a>isTypedKey
 
 [**@xylabs/typeof**](#../README)
@@ -1779,19 +1903,23 @@ function isTypedArray(value): value is TypedArray;
 ***
 
 ```ts
-function isTypedKey(value): value is string | number | symbol;
+function isTypedKey(value: unknown): value is string | number | symbol;
 ```
 
-## Parameters
+Type guard that checks whether a value is a valid TypedKey (string, bigint, number, or symbol).
 
-### value
+## Parameters
 
-`unknown`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to check. |
 
 ## Returns
 
 value is string \| number \| symbol
 
+True if the value is a valid TypedKey.
+
   ### <a id="isTypedObject"></a>isTypedObject
 
 [**@xylabs/typeof**](#../README)
@@ -1799,19 +1927,23 @@ value is string \| number \| symbol
 ***
 
 ```ts
-function isTypedObject(value): value is TypedObject;
+function isTypedObject(value: unknown): value is TypedObject;
 ```
 
+Type guard that checks whether a value is a TypedObject (an object with TypedKey keys and TypedValue values).
+
 ## Parameters
 
-### value
-
-`unknown`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to check. |
 
 ## Returns
 
 `value is TypedObject`
 
+True if the value is a valid TypedObject.
+
   ### <a id="isTypedValue"></a>isTypedValue
 
 [**@xylabs/typeof**](#../README)
@@ -1819,19 +1951,23 @@ function isTypedObject(value): value is TypedObject;
 ***
 
 ```ts
-function isTypedValue(value): value is TypedValue;
+function isTypedValue(value: unknown): value is TypedValue;
 ```
 
-## Parameters
+Type guard that checks whether a value is a valid TypedValue.
 
-### value
+## Parameters
 
-`unknown`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to check. |
 
 ## Returns
 
 `value is TypedValue`
 
+True if the value is a string, number, boolean, null, TypedObject, or TypedArray.
+
   ### <a id="isUndefined"></a>isUndefined
 
 [**@xylabs/typeof**](#../README)
@@ -1841,14 +1977,16 @@ function isTypedValue(value): value is TypedValue;
 ## Call Signature
 
 ```ts
-function isUndefined(value): value is undefined;
+function isUndefined(value: unknown): value is undefined;
 ```
 
+Type guard that checks whether a value is undefined.
+
 ### Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1857,20 +1995,22 @@ function isUndefined(value): value is undefined;
 ## Call Signature
 
 ```ts
-function isUndefined<T>(value): value is Extract<T, undefined>;
+function isUndefined<T>(value: T): value is Extract<T, undefined>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is undefined.
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1885,14 +2025,16 @@ function isUndefined<T>(value): value is Extract<T, undefined>;
 ## Call Signature
 
 ```ts
-function isUndefinedOrNull(value): value is null | undefined;
+function isUndefinedOrNull(value: unknown): value is null | undefined;
 ```
 
-### Parameters
+Type guard that checks whether a value is undefined or null.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1901,20 +2043,22 @@ value is null \| undefined
 ## Call Signature
 
 ```ts
-function isUndefinedOrNull<T>(value): value is Extract<T, null | undefined>;
+function isUndefinedOrNull<T>(value: T): value is Extract<T, null | undefined>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is undefined or null.
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1927,19 +2071,23 @@ value is Extract\<T, null \| undefined\>
 ***
 
 ```ts
-function isValidTypedFieldPair(pair): pair is [key: string | number | symbol, value: TypedValue];
+function isValidTypedFieldPair(pair: [unknown, unknown]): pair is [key: string | number | symbol, value: TypedValue];
 ```
 
-## Parameters
+Type guard that checks whether a key-value pair has a valid TypedKey and TypedValue.
 
-### pair
+## Parameters
 
-\[`unknown`, `unknown`\]
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `pair` | \[`unknown`, `unknown`\] | A tuple of [key, value] to validate. |
 
 ## Returns
 
 pair is \[key: string \| number \| symbol, value: TypedValue\]
 
+True if the key is a TypedKey and the value is a TypedValue.
+
   ### <a id="isWeakMap"></a>isWeakMap
 
 [**@xylabs/typeof**](#../README)
@@ -1949,14 +2097,16 @@ pair is \[key: string \| number \| symbol, value: TypedValue\]
 ## Call Signature
 
 ```ts
-function isWeakMap(value): value is WeakMap<WeakKey, unknown>;
+function isWeakMap(value: unknown): value is WeakMap<WeakKey, unknown>;
 ```
 
+Type guard that checks whether a value is a WeakMap instance.
+
 ### Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -1965,28 +2115,24 @@ function isWeakMap(value): value is WeakMap<WeakKey, unknown>;
 ## Call Signature
 
 ```ts
-function isWeakMap<K, V, T>(value): value is Extract<T, WeakMap<K, V>>;
+function isWeakMap<K, V, T>(value: T): value is Extract<T, WeakMap<K, V>>;
 ```
 
-### Type Parameters
-
-### K
-
-`K` *extends* `WeakKey`
-
-### V
+Type guard that checks whether a value is a WeakMap instance.
 
-`V`
-
-### T
+### Type Parameters
 
-`T` *extends* `WeakMap`\<`K`, `V`\>
+| Type Parameter |
+| ------ |
+| `K` *extends* `WeakKey` |
+| `V` |
+| `T` *extends* `WeakMap`\<`K`, `V`\> |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -2001,14 +2147,16 @@ function isWeakMap<K, V, T>(value): value is Extract<T, WeakMap<K, V>>;
 ## Call Signature
 
 ```ts
-function isWeakSet(value): value is WeakSet<WeakKey>;
+function isWeakSet(value: unknown): value is WeakSet<WeakKey>;
 ```
 
-### Parameters
+Type guard that checks whether a value is a WeakSet instance.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -2017,24 +2165,23 @@ function isWeakSet(value): value is WeakSet<WeakKey>;
 ## Call Signature
 
 ```ts
-function isWeakSet<K, T>(value): value is Extract<T, WeakSet<K>>;
+function isWeakSet<K, T>(value: T): value is Extract<T, WeakSet<K>>;
 ```
 
-### Type Parameters
-
-### K
+Type guard that checks whether a value is a WeakSet instance.
 
-`K` *extends* `WeakKey`
-
-### T
+### Type Parameters
 
-`T` *extends* `WeakSet`\<`K`\>
+| Type Parameter |
+| ------ |
+| `K` *extends* `WeakKey` |
+| `T` *extends* `WeakSet`\<`K`\> |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -2047,25 +2194,29 @@ function isWeakSet<K, T>(value): value is Extract<T, WeakSet<K>>;
 ***
 
 ```ts
-function typeOf<T>(item): TypeOfTypes;
+function typeOf<T>(item: T): TypeOfTypes;
 ```
 
-## Type Parameters
+Extended typeof that distinguishes arrays from objects (unlike native `typeof`).
 
-### T
+## Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ## Parameters
 
-### item
-
-`T`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `item` | `T` | The value to check. |
 
 ## Returns
 
 [`TypeOfTypes`](#../type-aliases/TypeOfTypes)
 
+The type of the item as a TypeOfTypes string.
+
   ### <a id="validateType"></a>validateType
 
 [**@xylabs/typeof**](#../README)
@@ -2074,35 +2225,33 @@ function typeOf<T>(item): TypeOfTypes;
 
 ```ts
 function validateType<T>(
-   typeName, 
-   value, 
-   optional?): [T | undefined, Error[]];
+   typeName: TypeOfTypes, 
+   value: T, 
+   optional?: boolean): [T | undefined, Error[]];
 ```
 
-## Type Parameters
+Validates that a value matches the expected type, returning the value and any errors.
 
-### T
+## Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ## Parameters
 
-### typeName
-
-[`TypeOfTypes`](#../type-aliases/TypeOfTypes)
-
-### value
-
-`T`
-
-### optional?
-
-`boolean` = `false`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `typeName` | [`TypeOfTypes`](#../type-aliases/TypeOfTypes) | `undefined` | The expected type name. |
+| `value` | `T` | `undefined` | The value to validate. |
+| `optional` | `boolean` | `false` | If true, undefined values are accepted without error. |
 
 ## Returns
 
 \[`T` \| `undefined`, `Error`[]\]
 
+A tuple of [value or undefined, array of errors].
+
 ### type-aliases
 
   ### <a id="AnyFunction"></a>AnyFunction
@@ -2112,14 +2261,16 @@ function validateType<T>(
 ***
 
 ```ts
-type AnyFunction = (...args) => unknown;
+type AnyFunction = (...args: unknown[]) => unknown;
 ```
 
-## Parameters
+A function type that accepts any arguments and returns unknown.
 
-### args
+## Parameters
 
-...`unknown`[]
+| Parameter | Type |
+| ------ | ------ |
+| ...`args` | `unknown`[] |
 
 ## Returns
 
@@ -2135,15 +2286,14 @@ type AnyFunction = (...args) => unknown;
 type Brand<T, B> = T & { [K in keyof B]: B[K] };
 ```
 
-## Type Parameters
-
-### T
+Creates a branded type by intersecting base type T with brand type B, enabling nominal typing in TypeScript.
 
-`T`
-
-### B
+## Type Parameters
 
-`B`
+| Type Parameter |
+| ------ |
+| `T` |
+| `B` |
 
   ### <a id="FieldType"></a>FieldType
 
@@ -2163,6 +2313,8 @@ type FieldType =
   | "function";
 ```
 
+Union of string literals representing the possible types of an object field.
+
   ### <a id="IdentityFunction"></a>IdentityFunction
 
 [**@xylabs/typeof**](#../README)
@@ -2170,20 +2322,22 @@ type FieldType =
 ***
 
 ```ts
-type IdentityFunction<T> = (value) => value is T;
+type IdentityFunction<T> = (value: unknown) => value is T;
 ```
 
-## Type Parameters
+A type guard function that narrows an unknown value to type T.
 
-### T
+## Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ## Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ## Returns
 
@@ -2199,6 +2353,8 @@ type IdentityFunction<T> = (value) => value is T;
 type ObjectTypeShape = Record<string | number | symbol, FieldType>;
 ```
 
+Describes the expected shape of an object by mapping each key to its expected field type.
+
   ### <a id="RecordKey"></a>RecordKey
 
 [**@xylabs/typeof**](#../README)
@@ -2209,6 +2365,8 @@ type ObjectTypeShape = Record<string | number | symbol, FieldType>;
 type RecordKey = string | number | symbol;
 ```
 
+A union of valid object key types.
+
   ### <a id="TypeOfTypes"></a>TypeOfTypes
 
 [**@xylabs/typeof**](#../README)
@@ -2230,6 +2388,8 @@ type TypeOfTypes =
   | "symbol";
 ```
 
+Union of string literals representing the possible results of the extended `typeOf` function.
+
   ### <a id="TypedArray"></a>TypedArray
 
 [**@xylabs/typeof**](#../README)
@@ -2240,6 +2400,8 @@ type TypeOfTypes =
 type TypedArray = TypedValue[];
 ```
 
+An array of TypedValue elements.
+
   ### <a id="TypedKey"></a>TypedKey
 
 [**@xylabs/typeof**](#../README)
@@ -2250,11 +2412,13 @@ type TypedArray = TypedValue[];
 type TypedKey<T> = T extends string ? T : string | number | symbol;
 ```
 
-## Type Parameters
+A valid key for a typed object. Defaults to string | number | symbol unless narrowed by T.
 
-### T
+## Type Parameters
 
-`T` *extends* `string` \| `void` = `void`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `string` \| `void` | `void` |
 
   ### <a id="TypedObject"></a>TypedObject
 
@@ -2270,6 +2434,8 @@ type TypedObject =
   | object;
 ```
 
+An object whose keys are TypedKey and whose values are TypedValue.
+
   ### <a id="TypedValue"></a>TypedValue
 
 [**@xylabs/typeof**](#../README)
@@ -2290,6 +2456,8 @@ type TypedValue =
   | undefined;
 ```
 
+A value that can appear in a typed object tree (primitives, objects, arrays, functions, and symbols).
+
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)