@xylabs/typeof 5.0.83 → 5.0.84

package/README.md

@@ -94,6 +94,8 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 function ifDefined<T>(value, func): T | undefined;
 ```
 
+Invokes the callback only if the value is neither null nor undefined.
+
 ## Type Parameters
 
 ### T
@@ -106,14 +108,20 @@ function ifDefined<T>(value, func): T | undefined;
 
 `T`
 
+The value to check.
+
 ### func
 
 (`value`) => `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)
@@ -128,6 +136,8 @@ function ifTypeOf<T, R>(
    isFunc?): R | undefined;
 ```
 
+Invokes the callback if the value matches the specified type, with an optional additional predicate.
+
 ## Type Parameters
 
 ### T
@@ -144,22 +154,32 @@ function ifTypeOf<T, R>(
 
 [`TypeOfTypes`](#../type-aliases/TypeOfTypes)
 
+The expected type name to match against.
+
 ### value
 
 `unknown`
 
+The value to check.
+
 ### trueFunc
 
 (`value`) => `R`
 
+The callback to invoke if the type matches.
+
 ### isFunc?
 
 (`value`) => `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)
@@ -172,6 +192,8 @@ function ifTypeOf<T, R>(
 function isArray(value): value is readonly unknown[];
 ```
 
+Type guard that checks whether a value is an array.
+
 ### Parameters
 
 ### value
@@ -188,6 +210,8 @@ function isArray(value): value is readonly unknown[];
 function isArray<T>(value): value is Extract<T, readonly unknown[]>;
 ```
 
+Type guard that checks whether a value is an array.
+
 ### Type Parameters
 
 ### T
@@ -216,6 +240,8 @@ function isArray<T>(value): value is Extract<T, readonly unknown[]>;
 function isArrayBufferView(value): value is ArrayBufferView<ArrayBufferLike>;
 ```
 
+Type guard that checks whether a value is an ArrayBufferView (e.g., TypedArray or DataView).
+
 ### Parameters
 
 ### value
@@ -232,6 +258,8 @@ function isArrayBufferView(value): value is ArrayBufferView<ArrayBufferLike>;
 function isArrayBufferView<T>(value): value is Extract<T, ArrayBufferView<ArrayBufferLike>>;
 ```
 
+Type guard that checks whether a value is an ArrayBufferView (e.g., TypedArray or DataView).
+
 ### Type Parameters
 
 ### T
@@ -260,6 +288,8 @@ function isArrayBufferView<T>(value): value is Extract<T, ArrayBufferView<ArrayB
 function isBigInt(value): value is bigint;
 ```
 
+Type guard that checks whether a value is a bigint.
+
 ### Parameters
 
 ### value
@@ -276,6 +306,8 @@ function isBigInt(value): value is bigint;
 function isBigInt<T>(value): value is Extract<T, bigint>;
 ```
 
+Type guard that checks whether a value is a bigint.
+
 ### Type Parameters
 
 ### T
@@ -304,6 +336,8 @@ function isBigInt<T>(value): value is Extract<T, bigint>;
 function isBlob(value): value is Blob;
 ```
 
+Type guard that checks whether a value is a Blob instance.
+
 ### Parameters
 
 ### value
@@ -320,6 +354,8 @@ function isBlob(value): value is Blob;
 function isBlob<T>(value): value is Extract<T, Blob>;
 ```
 
+Type guard that checks whether a value is a Blob instance.
+
 ### Type Parameters
 
 ### T
@@ -348,6 +384,8 @@ function isBlob<T>(value): value is Extract<T, Blob>;
 function isBoolean(value): value is boolean;
 ```
 
+Type guard that checks whether a value is a boolean.
+
 ### Parameters
 
 ### value
@@ -364,6 +402,8 @@ function isBoolean(value): value is boolean;
 function isBoolean<T>(value): value is Extract<T, boolean>;
 ```
 
+Type guard that checks whether a value is a boolean.
+
 ### Type Parameters
 
 ### T
@@ -392,6 +432,8 @@ function isBoolean<T>(value): value is Extract<T, boolean>;
 function isDataView(value): value is DataView<ArrayBufferLike>;
 ```
 
+Type guard that checks whether a value is a DataView instance.
+
 ### Parameters
 
 ### value
@@ -408,6 +450,8 @@ function isDataView(value): value is DataView<ArrayBufferLike>;
 function isDataView<T>(value): value is Extract<T, DataView<ArrayBufferLike>>;
 ```
 
+Type guard that checks whether a value is a DataView instance.
+
 ### Type Parameters
 
 ### T
@@ -436,6 +480,8 @@ function isDataView<T>(value): value is Extract<T, DataView<ArrayBufferLike>>;
 function isDate(value): value is Date;
 ```
 
+Type guard that checks whether a value is a Date instance.
+
 ### Parameters
 
 ### value
@@ -452,6 +498,8 @@ function isDate(value): value is Date;
 function isDate<T>(value): value is Extract<T, Date>;
 ```
 
+Type guard that checks whether a value is a Date instance.
+
 ### Type Parameters
 
 ### T
@@ -480,6 +528,8 @@ function isDate<T>(value): value is Extract<T, Date>;
 function isDateString(value): value is string;
 ```
 
+Type guard that checks whether a value is a string that can be parsed as a valid date.
+
 ### Parameters
 
 ### value
@@ -496,6 +546,8 @@ function isDateString(value): value is string;
 function isDateString<T>(value): value is Extract<T, string>;
 ```
 
+Type guard that checks whether a value is a string that can be parsed as a valid date.
+
 ### Type Parameters
 
 ### T
@@ -522,6 +574,8 @@ function isDateString<T>(value): value is Extract<T, string>;
 function isDefined<T>(value): value is Exclude<T, undefined>;
 ```
 
+Type guard that checks whether a value is not undefined.
+
 ## Type Parameters
 
 ### T
@@ -548,6 +602,8 @@ function isDefined<T>(value): value is Exclude<T, undefined>;
 function isDefinedNotNull<T>(value): value is Exclude<T, null | undefined>;
 ```
 
+Type guard that checks whether a value is neither undefined nor null.
+
 ## Type Parameters
 
 ### T
@@ -576,6 +632,8 @@ value is Exclude\<T, null \| undefined\>
 function isEmpty<T>(value): value is T;
 ```
 
+Type guard that checks whether a value is empty (empty string, empty array, or empty object).
+
 ### Type Parameters
 
 ### T
@@ -598,6 +656,8 @@ function isEmpty<T>(value): value is T;
 function isEmpty<K, V, T>(value): value is Extract<T, Record<K, never>>;
 ```
 
+Type guard that checks whether a value is empty (empty string, empty array, or empty object).
+
 ### Type Parameters
 
 ### K
@@ -628,6 +688,8 @@ function isEmpty<K, V, T>(value): value is Extract<T, Record<K, never>>;
 function isEmpty<T>(value): value is Extract<T, never[]>;
 ```
 
+Type guard that checks whether a value is empty (empty string, empty array, or empty object).
+
 ### Type Parameters
 
 ### T
@@ -656,6 +718,8 @@ function isEmpty<T>(value): value is Extract<T, never[]>;
 function isEmptyArray(value): value is [];
 ```
 
+Type guard that checks whether a value is an empty array.
+
 ### Parameters
 
 ### value
@@ -672,6 +736,8 @@ function isEmptyArray(value): value is [];
 function isEmptyArray<T>(value): value is Extract<T, unknown[]>;
 ```
 
+Type guard that checks whether a value is an empty array.
+
 ### Type Parameters
 
 ### T
@@ -700,6 +766,8 @@ function isEmptyArray<T>(value): value is Extract<T, unknown[]>;
 function isEmptyObject(value): value is {};
 ```
 
+Type guard that checks whether a value is an object with no own keys.
+
 ### Parameters
 
 ### value
@@ -716,6 +784,8 @@ function isEmptyObject(value): value is {};
 function isEmptyObject<K, V, T>(value): value is Extract<T, Record<K, never>>;
 ```
 
+Type guard that checks whether a value is an object with no own keys.
+
 ### Type Parameters
 
 ### K
@@ -752,6 +822,8 @@ function isEmptyObject<K, V, T>(value): value is Extract<T, Record<K, never>>;
 function isEmptyString(value): value is "";
 ```
 
+Type guard that checks whether a value is an empty string.
+
 ### Parameters
 
 ### value
@@ -768,6 +840,8 @@ function isEmptyString(value): value is "";
 function isEmptyString<T>(value): value is Extract<T, "">;
 ```
 
+Type guard that checks whether a value is an empty string.
+
 ### Type Parameters
 
 ### T
@@ -796,6 +870,8 @@ function isEmptyString<T>(value): value is Extract<T, "">;
 function isError(value): value is Error;
 ```
 
+Type guard that checks whether a value is an Error instance.
+
 ### Parameters
 
 ### value
@@ -812,6 +888,8 @@ function isError(value): value is Error;
 function isError<T>(value): value is Extract<T, Error>;
 ```
 
+Type guard that checks whether a value is an Error instance.
+
 ### Type Parameters
 
 ### T
@@ -840,6 +918,8 @@ function isError<T>(value): value is Extract<T, Error>;
 function isFalsy<T>(value): value is Extract<T, false | "" | 0 | 0n | null | undefined>;
 ```
 
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -862,6 +942,8 @@ value is Extract\<T, false \| "" \| 0 \| 0n \| null \| undefined\>
 function isFalsy<T>(value): value is Extract<T, false>;
 ```
 
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -884,6 +966,8 @@ function isFalsy<T>(value): value is Extract<T, false>;
 function isFalsy<T>(value): value is Extract<T, 0>;
 ```
 
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -906,6 +990,8 @@ function isFalsy<T>(value): value is Extract<T, 0>;
 function isFalsy<T>(value): value is Extract<T, 0n>;
 ```
 
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -928,6 +1014,8 @@ function isFalsy<T>(value): value is Extract<T, 0n>;
 function isFalsy<T>(value): value is Extract<T, null>;
 ```
 
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -950,6 +1038,8 @@ function isFalsy<T>(value): value is Extract<T, null>;
 function isFalsy<T>(value): value is Extract<T, undefined>;
 ```
 
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -972,6 +1062,8 @@ function isFalsy<T>(value): value is Extract<T, undefined>;
 function isFalsy<T>(value): value is Extract<T, "">;
 ```
 
+Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -1000,6 +1092,8 @@ function isFalsy<T>(value): value is Extract<T, "">;
 function isFile(value): value is File;
 ```
 
+Type guard that checks whether a value is a File instance.
+
 ### Parameters
 
 ### value
@@ -1016,6 +1110,8 @@ function isFile(value): value is File;
 function isFile<T>(value): value is Extract<T, File>;
 ```
 
+Type guard that checks whether a value is a File instance.
+
 ### Type Parameters
 
 ### T
@@ -1044,6 +1140,8 @@ function isFile<T>(value): value is Extract<T, File>;
 function isFunction(value): value is AnyFunction;
 ```
 
+Type guard that checks whether a value is a function.
+
 ### Parameters
 
 ### value
@@ -1060,6 +1158,8 @@ function isFunction(value): value is AnyFunction;
 function isFunction<T>(value): value is Extract<T, AnyFunction>;
 ```
 
+Type guard that checks whether a value is a function.
+
 ### Type Parameters
 
 ### T
@@ -1088,6 +1188,8 @@ function isFunction<T>(value): value is Extract<T, AnyFunction>;
 function isMap(value): value is Map<unknown, unknown>;
 ```
 
+Type guard that checks whether a value is a Map instance.
+
 ### Parameters
 
 ### value
@@ -1104,6 +1206,8 @@ function isMap(value): value is Map<unknown, unknown>;
 function isMap<K, V, T>(value): value is Extract<T, Map<K, V>>;
 ```
 
+Type guard that checks whether a value is a Map instance.
+
 ### Type Parameters
 
 ### K
@@ -1140,6 +1244,8 @@ function isMap<K, V, T>(value): value is Extract<T, Map<K, V>>;
 function isNull(value): value is null;
 ```
 
+Type guard that checks whether a value is null.
+
 ### Parameters
 
 ### value
@@ -1156,6 +1262,8 @@ function isNull(value): value is null;
 function isNull<T>(value): value is Extract<T, null>;
 ```
 
+Type guard that checks whether a value is null.
+
 ### Type Parameters
 
 ### T
@@ -1184,6 +1292,8 @@ function isNull<T>(value): value is Extract<T, null>;
 function isNumber(value): value is number;
 ```
 
+Type guard that checks whether a value is a number.
+
 ### Parameters
 
 ### value
@@ -1200,6 +1310,8 @@ function isNumber(value): value is number;
 function isNumber<T>(value): value is Extract<T, number>;
 ```
 
+Type guard that checks whether a value is a number.
+
 ### Type Parameters
 
 ### T
@@ -1228,6 +1340,8 @@ function isNumber<T>(value): value is Extract<T, number>;
 function isObject(value): value is object;
 ```
 
+Type guard that checks whether a value is a plain object (not null and not an array).
+
 ### Parameters
 
 ### value
@@ -1244,6 +1358,8 @@ function isObject(value): value is object;
 function isObject<T>(value): value is Extract<T, object>;
 ```
 
+Type guard that checks whether a value is a plain object (not null and not an array).
+
 ### Type Parameters
 
 ### T
@@ -1272,6 +1388,8 @@ function isObject<T>(value): value is Extract<T, object>;
 function isPopulatedArray(value): value is readonly unknown[];
 ```
 
+Type guard that checks whether a value is a non-empty array.
+
 ### Parameters
 
 ### value
@@ -1288,6 +1406,8 @@ function isPopulatedArray(value): value is readonly unknown[];
 function isPopulatedArray<T>(value): value is Extract<T, readonly unknown[]>;
 ```
 
+Type guard that checks whether a value is a non-empty array.
+
 ### Type Parameters
 
 ### T
@@ -1316,6 +1436,8 @@ function isPopulatedArray<T>(value): value is Extract<T, readonly unknown[]>;
 function isPromise(value): value is Promise<unknown>;
 ```
 
+Type guard that checks whether a value is a Promise instance.
+
 ### Parameters
 
 ### value
@@ -1332,6 +1454,8 @@ function isPromise(value): value is Promise<unknown>;
 function isPromise<T>(value): value is Extract<T, Promise<unknown>>;
 ```
 
+Type guard that checks whether a value is a Promise instance.
+
 ### Type Parameters
 
 ### T
@@ -1360,6 +1484,8 @@ function isPromise<T>(value): value is Extract<T, Promise<unknown>>;
 function isPromiseLike(value): value is Promise<unknown>;
 ```
 
+Type guard that checks whether a value is promise-like (has a `then` method).
+
 ### Parameters
 
 ### value
@@ -1376,6 +1502,8 @@ function isPromiseLike(value): value is Promise<unknown>;
 function isPromiseLike<T>(value): value is Extract<T, Promise<unknown>>;
 ```
 
+Type guard that checks whether a value is promise-like (has a `then` method).
+
 ### Type Parameters
 
 ### T
@@ -1404,6 +1532,8 @@ function isPromiseLike<T>(value): value is Extract<T, Promise<unknown>>;
 function isRegExp(value): value is RegExp;
 ```
 
+Type guard that checks whether a value is a RegExp instance.
+
 ### Parameters
 
 ### value
@@ -1420,6 +1550,8 @@ function isRegExp(value): value is RegExp;
 function isRegExp<T>(value): value is Extract<T, RegExp>;
 ```
 
+Type guard that checks whether a value is a RegExp instance.
+
 ### Type Parameters
 
 ### T
@@ -1448,6 +1580,8 @@ function isRegExp<T>(value): value is Extract<T, RegExp>;
 function isSet(value): value is Set<unknown>;
 ```
 
+Type guard that checks whether a value is a Set instance.
+
 ### Parameters
 
 ### value
@@ -1464,6 +1598,8 @@ function isSet(value): value is Set<unknown>;
 function isSet<T>(value): value is Extract<T, Set<unknown>>;
 ```
 
+Type guard that checks whether a value is a Set instance.
+
 ### Type Parameters
 
 ### T
@@ -1492,6 +1628,8 @@ function isSet<T>(value): value is Extract<T, Set<unknown>>;
 function isString(value): value is string;
 ```
 
+Type guard that checks whether a value is a string.
+
 ### Parameters
 
 ### value
@@ -1508,6 +1646,8 @@ function isString(value): value is string;
 function isString<T>(value): value is Extract<T, string>;
 ```
 
+Type guard that checks whether a value is a string.
+
 ### Type Parameters
 
 ### T
@@ -1536,6 +1676,8 @@ function isString<T>(value): value is Extract<T, string>;
 function isSymbol(value): value is symbol;
 ```
 
+Type guard that checks whether a value is a symbol.
+
 ### Parameters
 
 ### value
@@ -1552,6 +1694,8 @@ function isSymbol(value): value is symbol;
 function isSymbol<T>(value): value is Extract<T, symbol>;
 ```
 
+Type guard that checks whether a value is a symbol.
+
 ### Type Parameters
 
 ### T
@@ -1580,6 +1724,8 @@ function isSymbol<T>(value): value is Extract<T, symbol>;
 function isTruthy<T>(value): value is Exclude<T, false | "" | 0 | 0n | null | undefined>;
 ```
 
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -1602,6 +1748,8 @@ value is Exclude\<T, false \| "" \| 0 \| 0n \| null \| undefined\>
 function isTruthy<T>(value): value is Extract<T, true>;
 ```
 
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -1624,6 +1772,8 @@ function isTruthy<T>(value): value is Extract<T, true>;
 function isTruthy<T>(value): value is Extract<T, number>;
 ```
 
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -1646,6 +1796,8 @@ function isTruthy<T>(value): value is Extract<T, number>;
 function isTruthy<T>(value): value is Extract<T, bigint>;
 ```
 
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -1668,6 +1820,8 @@ function isTruthy<T>(value): value is Extract<T, bigint>;
 function isTruthy<T>(value): value is Extract<T, null>;
 ```
 
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -1690,6 +1844,8 @@ function isTruthy<T>(value): value is Extract<T, null>;
 function isTruthy<T>(value): value is Extract<T, undefined>;
 ```
 
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -1712,6 +1868,8 @@ function isTruthy<T>(value): value is Extract<T, undefined>;
 function isTruthy<T>(value): value is Extract<T, string>;
 ```
 
+Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
+
 ### Type Parameters
 
 ### T
@@ -1738,20 +1896,28 @@ function isTruthy<T>(value): value is Extract<T, string>;
 function isType(value, expectedType): boolean;
 ```
 
+Checks whether a value matches the expected field type, with correct handling for arrays and nulls.
+
 ## Parameters
 
 ### 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)
@@ -1762,16 +1928,22 @@ function isType(value, expectedType): boolean;
 function isTypedArray(value): value is TypedArray;
 ```
 
+Type guard that checks whether a value is a TypedArray (an array where every element is a TypedValue).
+
 ## Parameters
 
 ### 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)
@@ -1782,16 +1954,22 @@ function isTypedArray(value): value is TypedArray;
 function isTypedKey(value): value is string | number | symbol;
 ```
 
+Type guard that checks whether a value is a valid TypedKey (string, bigint, number, or symbol).
+
 ## Parameters
 
 ### 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)
@@ -1802,16 +1980,22 @@ value is string \| number \| symbol
 function isTypedObject(value): value is TypedObject;
 ```
 
+Type guard that checks whether a value is a TypedObject (an object with TypedKey keys and TypedValue values).
+
 ## Parameters
 
 ### 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)
@@ -1822,16 +2006,22 @@ function isTypedObject(value): value is TypedObject;
 function isTypedValue(value): value is TypedValue;
 ```
 
+Type guard that checks whether a value is a valid TypedValue.
+
 ## Parameters
 
 ### 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)
@@ -1844,6 +2034,8 @@ function isTypedValue(value): value is TypedValue;
 function isUndefined(value): value is undefined;
 ```
 
+Type guard that checks whether a value is undefined.
+
 ### Parameters
 
 ### value
@@ -1860,6 +2052,8 @@ function isUndefined(value): value is undefined;
 function isUndefined<T>(value): value is Extract<T, undefined>;
 ```
 
+Type guard that checks whether a value is undefined.
+
 ### Type Parameters
 
 ### T
@@ -1888,6 +2082,8 @@ function isUndefined<T>(value): value is Extract<T, undefined>;
 function isUndefinedOrNull(value): value is null | undefined;
 ```
 
+Type guard that checks whether a value is undefined or null.
+
 ### Parameters
 
 ### value
@@ -1904,6 +2100,8 @@ value is null \| undefined
 function isUndefinedOrNull<T>(value): value is Extract<T, null | undefined>;
 ```
 
+Type guard that checks whether a value is undefined or null.
+
 ### Type Parameters
 
 ### T
@@ -1930,16 +2128,22 @@ value is Extract\<T, null \| undefined\>
 function isValidTypedFieldPair(pair): pair is [key: string | number | symbol, value: TypedValue];
 ```
 
+Type guard that checks whether a key-value pair has a valid TypedKey and TypedValue.
+
 ## Parameters
 
 ### 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)
@@ -1952,6 +2156,8 @@ pair is \[key: string \| number \| symbol, value: TypedValue\]
 function isWeakMap(value): value is WeakMap<WeakKey, unknown>;
 ```
 
+Type guard that checks whether a value is a WeakMap instance.
+
 ### Parameters
 
 ### value
@@ -1968,6 +2174,8 @@ function isWeakMap(value): value is WeakMap<WeakKey, unknown>;
 function isWeakMap<K, V, T>(value): value is Extract<T, WeakMap<K, V>>;
 ```
 
+Type guard that checks whether a value is a WeakMap instance.
+
 ### Type Parameters
 
 ### K
@@ -2004,6 +2212,8 @@ function isWeakMap<K, V, T>(value): value is Extract<T, WeakMap<K, V>>;
 function isWeakSet(value): value is WeakSet<WeakKey>;
 ```
 
+Type guard that checks whether a value is a WeakSet instance.
+
 ### Parameters
 
 ### value
@@ -2020,6 +2230,8 @@ function isWeakSet(value): value is WeakSet<WeakKey>;
 function isWeakSet<K, T>(value): value is Extract<T, WeakSet<K>>;
 ```
 
+Type guard that checks whether a value is a WeakSet instance.
+
 ### Type Parameters
 
 ### K
@@ -2050,6 +2262,8 @@ function isWeakSet<K, T>(value): value is Extract<T, WeakSet<K>>;
 function typeOf<T>(item): TypeOfTypes;
 ```
 
+Extended typeof that distinguishes arrays from objects (unlike native `typeof`).
+
 ## Type Parameters
 
 ### T
@@ -2062,10 +2276,14 @@ function typeOf<T>(item): TypeOfTypes;
 
 `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)
@@ -2079,6 +2297,8 @@ function validateType<T>(
    optional?): [T | undefined, Error[]];
 ```
 
+Validates that a value matches the expected type, returning the value and any errors.
+
 ## Type Parameters
 
 ### T
@@ -2091,18 +2311,26 @@ function validateType<T>(
 
 [`TypeOfTypes`](#../type-aliases/TypeOfTypes)
 
+The expected type name.
+
 ### value
 
 `T`
 
+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
@@ -2115,6 +2343,8 @@ function validateType<T>(
 type AnyFunction = (...args) => unknown;
 ```
 
+A function type that accepts any arguments and returns unknown.
+
 ## Parameters
 
 ### args
@@ -2135,6 +2365,8 @@ type AnyFunction = (...args) => unknown;
 type Brand<T, B> = T & { [K in keyof B]: B[K] };
 ```
 
+Creates a branded type by intersecting base type T with brand type B, enabling nominal typing in TypeScript.
+
 ## Type Parameters
 
 ### T
@@ -2163,6 +2395,8 @@ type FieldType =
   | "function";
 ```
 
+Union of string literals representing the possible types of an object field.
+
   ### <a id="IdentityFunction"></a>IdentityFunction
 
 [**@xylabs/typeof**](#../README)
@@ -2173,6 +2407,8 @@ type FieldType =
 type IdentityFunction<T> = (value) => value is T;
 ```
 
+A type guard function that narrows an unknown value to type T.
+
 ## Type Parameters
 
 ### T
@@ -2199,6 +2435,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 +2447,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 +2470,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 +2482,8 @@ type TypeOfTypes =
 type TypedArray = TypedValue[];
 ```
 
+An array of TypedValue elements.
+
   ### <a id="TypedKey"></a>TypedKey
 
 [**@xylabs/typeof**](#../README)
@@ -2250,6 +2494,8 @@ type TypedArray = TypedValue[];
 type TypedKey<T> = T extends string ? T : string | number | symbol;
 ```
 
+A valid key for a typed object. Defaults to string | number | symbol unless narrowed by T.
+
 ## Type Parameters
 
 ### T
@@ -2270,6 +2516,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 +2538,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)