@xylabs/object 5.0.83 → 5.0.86

package/README.md

@@ -15,6 +15,8 @@
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+
+
 ## Reference
 
 **@xylabs/object**
@@ -23,9 +25,11 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Modules
 
-- [index-deprecated](#index-deprecated/README)
-- [index-un-deprecated](#index-un-deprecated/README)
-- [index](#index/README)
+| Module | Description |
+| ------ | ------ |
+| [index-deprecated](#index-deprecated/README) | - |
+| [index-un-deprecated](#index-un-deprecated/README) | - |
+| [index](#index/README) | - |
 
 ### index
 
@@ -39,11 +43,13 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ***
 
-## Type Parameters
+Factory class for creating type-guard functions that validate objects against a given shape and optional additional checks.
 
-### T
+## Type Parameters
 
-`T` *extends* `TypedObject`
+| Type Parameter |
+| ------ |
+| `T` *extends* `TypedObject` |
 
 ## Constructors
 
@@ -62,52 +68,55 @@ new IsObjectFactory<T>(): IsObjectFactory<T>;
 ### create()
 
 ```ts
-create(shape?, additionalChecks?): TypeCheck<T>;
+create(shape?: ObjectTypeShape, additionalChecks?: TypeCheck<TypedObject>[]): TypeCheck<T>;
 ```
 
-### Parameters
-
-#### shape?
+Creates a type-guard function that validates an object matches the given shape and passes additional checks.
 
-`ObjectTypeShape`
-
-#### additionalChecks?
+### Parameters
 
-[`TypeCheck`](#../type-aliases/TypeCheck)\<`TypedObject`\>[]
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `shape?` | `ObjectTypeShape` | An optional map of property names to expected types. |
+| `additionalChecks?` | [`TypeCheck`](#../type-aliases/TypeCheck)\<`TypedObject`\>[] | Optional extra type-check functions to run after shape validation. |
 
 ### Returns
 
 [`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>
 
+A type-guard function for type T.
+
     ### <a id="ObjectWrapper"></a>ObjectWrapper
 
 [**@xylabs/object**](#../../README)
 
 ***
 
+Abstract base class that wraps an object and provides typed access to it.
+
 ## Extended by
 
 - [`ValidatorBase`](#ValidatorBase)
 
 ## Type Parameters
 
-### T
-
-`T` *extends* [`EmptyObject`](#../type-aliases/EmptyObject) = [`EmptyObject`](#../type-aliases/EmptyObject)
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* [`EmptyObject`](#../type-aliases/EmptyObject) | [`EmptyObject`](#../type-aliases/EmptyObject) |
 
 ## Constructors
 
 ### Constructor
 
 ```ts
-new ObjectWrapper<T>(obj): ObjectWrapper<T>;
+new ObjectWrapper<T>(obj: T): ObjectWrapper<T>;
 ```
 
 ### Parameters
 
-#### obj
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `obj` | `T` |
 
 ### Returns
 
@@ -115,11 +124,9 @@ new ObjectWrapper<T>(obj): ObjectWrapper<T>;
 
 ## Properties
 
-### obj
-
-```ts
-readonly obj: T;
-```
+| Property | Modifier | Type |
+| ------ | ------ | ------ |
+| <a id="obj"></a> `obj` | `readonly` | `T` |
 
 ## Accessors
 
@@ -141,15 +148,17 @@ get protected stringKeyObj(): StringKeyObject;
 
 ***
 
+Abstract base class for validators that wraps a partial object and provides a validation method.
+
 ## Extends
 
 - [`ObjectWrapper`](#ObjectWrapper)\<`Partial`\<`T`\>\>
 
 ## Type Parameters
 
-### T
-
-`T` *extends* [`EmptyObject`](#../type-aliases/EmptyObject) = [`AnyObject`](#../type-aliases/AnyObject)
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* [`EmptyObject`](#../type-aliases/EmptyObject) | [`AnyObject`](#../type-aliases/AnyObject) |
 
 ## Implements
 
@@ -160,14 +169,14 @@ get protected stringKeyObj(): StringKeyObject;
 ### Constructor
 
 ```ts
-new ValidatorBase<T>(obj): ValidatorBase<T>;
+new ValidatorBase<T>(obj: T): ValidatorBase<T>;
 ```
 
 ### Parameters
 
-#### obj
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `obj` | `T` |
 
 ### Returns
 
@@ -179,15 +188,9 @@ new ValidatorBase<T>(obj): ValidatorBase<T>;
 
 ## Properties
 
-### obj
-
-```ts
-readonly obj: T;
-```
-
-### Inherited from
-
-[`ObjectWrapper`](#ObjectWrapper).[`obj`](ObjectWrapper.md#obj)
+| Property | Modifier | Type | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="obj"></a> `obj` | `readonly` | `T` | [`ObjectWrapper`](#ObjectWrapper).[`obj`](ObjectWrapper.md#obj) |
 
 ## Accessors
 
@@ -212,14 +215,14 @@ get protected stringKeyObj(): StringKeyObject;
 ### validate()
 
 ```ts
-abstract validate(payload): Promisable<Error[]>;
+abstract validate(payload: T): Promisable<Error[]>;
 ```
 
 ### Parameters
 
-#### payload
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `payload` | `T` |
 
 ### Returns
 
@@ -238,38 +241,36 @@ abstract validate(payload): Promisable<Error[]>;
 ***
 
 ```ts
-function createDeepMerge(options): <T>(...objects) => MergeAll<T>;
+function createDeepMerge(options: MergeOptions): <T>(...objects: T) => MergeAll<T>;
 ```
 
 Creates a deep merge function with the specified options.
 
 ## Parameters
 
-### options
-
-`MergeOptions`
-
-Options for merging.
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | `MergeOptions` | Options for merging. |
 
 ## Returns
 
 A deep merge function configured for the specified options.
 
 ```ts
-<T>(...objects): MergeAll<T>;
+<T>(...objects: T): MergeAll<T>;
 ```
 
 ### Type Parameters
 
-### T
-
-`T` *extends* [`AnyObject`](#../type-aliases/AnyObject)[]
+| Type Parameter |
+| ------ |
+| `T` *extends* [`AnyObject`](#../type-aliases/AnyObject)[] |
 
 ### Parameters
 
-### objects
-
-...`T`
+| Parameter | Type |
+| ------ | ------ |
+| ...`objects` | `T` |
 
 ### Returns
 
@@ -284,14 +285,16 @@ A deep merge function configured for the specified options.
 ## 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
 
@@ -300,20 +303,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
 
@@ -326,18 +331,15 @@ function isObject<T>(value): value is Extract<T, object>;
 ***
 
 ```ts
-function isType(value, expectedType): boolean;
+function isType(value: unknown, expectedType: FieldType): boolean;
 ```
 
 ## Parameters
 
-### value
-
-`unknown`
-
-### expectedType
-
-`FieldType`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
+| `expectedType` | `FieldType` |
 
 ## Returns
 
@@ -355,35 +357,33 @@ use from @xylabs/typeof instead
 
 ```ts
 function omitBy<T>(
-   obj, 
-   predicate, 
-maxDepth?): Partial<T>;
+   obj: T, 
+   predicate: OmitByPredicate, 
+maxDepth?: number): Partial<T>;
 ```
 
-## Type Parameters
+Creates a new object excluding properties that satisfy the predicate, with optional recursive depth.
 
-### T
+## Type Parameters
 
-`T` *extends* `object`
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |
 
 ## Parameters
 
-### obj
-
-`T`
-
-### predicate
-
-[`OmitByPredicate`](#../type-aliases/OmitByPredicate)
-
-### maxDepth?
-
-`number` = `1`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `obj` | `T` | `undefined` | The source object to omit properties from. |
+| `predicate` | [`OmitByPredicate`](#../type-aliases/OmitByPredicate) | `undefined` | A function that returns true for properties to exclude. |
+| `maxDepth` | `number` | `1` | Maximum recursion depth for nested objects. |
 
 ## Returns
 
 `Partial`\<`T`\>
 
+A partial copy of the object without matching properties.
+
     ### <a id="omitByPrefix"></a>omitByPrefix
 
 [**@xylabs/object**](#../../README)
@@ -392,39 +392,34 @@ maxDepth?): Partial<T>;
 
 ```ts
 function omitByPrefix<T, P>(
-   payload, 
-   prefix, 
-maxDepth?): DeepOmitStartsWith<T, P>;
+   payload: T, 
+   prefix: P, 
+maxDepth?: number): DeepOmitStartsWith<T, P>;
 ```
 
-## Type Parameters
-
-### T
-
-`T` *extends* `object`
+Omits all properties whose keys start with the given prefix, recursively through nested objects.
 
-### P
+## Type Parameters
 
-`P` *extends* `string`
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |
+| `P` *extends* `string` |
 
 ## Parameters
 
-### payload
-
-`T`
-
-### prefix
-
-`P`
-
-### maxDepth?
-
-`number` = `100`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `payload` | `T` | `undefined` | The source object. |
+| `prefix` | `P` | `undefined` | The string prefix to match keys against. |
+| `maxDepth` | `number` | `100` | Maximum recursion depth. |
 
 ## Returns
 
 [`DeepOmitStartsWith`](#../type-aliases/DeepOmitStartsWith)\<`T`, `P`\>
 
+A new object without properties that have matching prefixed keys.
+
     ### <a id="pickBy"></a>pickBy
 
 [**@xylabs/object**](#../../README)
@@ -433,35 +428,33 @@ maxDepth?): DeepOmitStartsWith<T, P>;
 
 ```ts
 function pickBy<T>(
-   obj, 
-   predicate, 
-maxDepth?): Partial<T>;
+   obj: T, 
+   predicate: PickByPredicate, 
+maxDepth?: number): Partial<T>;
 ```
 
-## Type Parameters
+Creates a new object containing only the properties that satisfy the predicate, with optional recursive depth.
 
-### T
+## Type Parameters
 
-`T` *extends* `object`
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |
 
 ## Parameters
 
-### obj
-
-`T`
-
-### predicate
-
-[`PickByPredicate`](#../type-aliases/PickByPredicate)
-
-### maxDepth?
-
-`number` = `1`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `obj` | `T` | `undefined` | The source object to pick properties from. |
+| `predicate` | [`PickByPredicate`](#../type-aliases/PickByPredicate) | `undefined` | A function that returns true for properties to include. |
+| `maxDepth` | `number` | `1` | Maximum recursion depth for nested objects. |
 
 ## Returns
 
 `Partial`\<`T`\>
 
+A partial copy of the object with only matching properties.
+
     ### <a id="pickByPrefix"></a>pickByPrefix
 
 [**@xylabs/object**](#../../README)
@@ -470,39 +463,34 @@ maxDepth?): Partial<T>;
 
 ```ts
 function pickByPrefix<T, P>(
-   payload, 
-   prefix, 
-maxDepth?): DeepPickStartsWith<T, P>;
+   payload: T, 
+   prefix: P, 
+maxDepth?: number): DeepPickStartsWith<T, P>;
 ```
 
-## Type Parameters
+Picks all properties whose keys start with the given prefix, recursively through nested objects.
 
-### T
-
-`T` *extends* `object`
-
-### P
+## Type Parameters
 
-`P` *extends* `string`
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |
+| `P` *extends* `string` |
 
 ## Parameters
 
-### payload
-
-`T`
-
-### prefix
-
-`P`
-
-### maxDepth?
-
-`number` = `100`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `payload` | `T` | `undefined` | The source object. |
+| `prefix` | `P` | `undefined` | The string prefix to match keys against. |
+| `maxDepth` | `number` | `100` | Maximum recursion depth. |
 
 ## Returns
 
 [`DeepPickStartsWith`](#../type-aliases/DeepPickStartsWith)\<`T`, `P`\>
 
+A new object containing only properties with matching prefixed keys.
+
     ### <a id="removeFields"></a>removeFields
 
 [**@xylabs/object**](#../../README)
@@ -510,33 +498,31 @@ maxDepth?): DeepPickStartsWith<T, P>;
 ***
 
 ```ts
-function removeFields<T, K>(obj, fields): Omit<T, K>;
+function removeFields<T, K>(obj: T, fields: K[]): Omit<T, K>;
 ```
 
-## Type Parameters
+Returns a shallow copy of the object with the specified fields removed.
 
-### T
-
-`T` *extends* `object`
-
-### K
+## Type Parameters
 
-`K` *extends* `string` \| `number` \| `symbol`
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |
+| `K` *extends* `string` \| `number` \| `symbol` |
 
 ## Parameters
 
-### obj
-
-`T`
-
-### fields
-
-`K`[]
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `obj` | `T` | The source object. |
+| `fields` | `K`[] | An array of keys to remove. |
 
 ## Returns
 
 `Omit`\<`T`, `K`\>
 
+A new object without the specified fields.
+
     ### <a id="toSafeJson"></a>toSafeJson
 
 [**@xylabs/object**](#../../README)
@@ -544,23 +530,24 @@ function removeFields<T, K>(obj, fields): Omit<T, K>;
 ***
 
 ```ts
-function toSafeJson(value, maxDepth?): unknown;
+function toSafeJson(value: unknown, maxDepth?: number): unknown;
 ```
 
-## Parameters
-
-### value
+Converts a value to a JSON-safe representation, handling circular references and non-serializable types.
 
-`unknown`
-
-### maxDepth?
+## Parameters
 
-`number` = `3`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `value` | `unknown` | `undefined` | The value to convert. |
+| `maxDepth` | `number` | `3` | Maximum recursion depth. |
 
 ## Returns
 
 `unknown`
 
+A JSON-safe value.
+
     ### <a id="toSafeJsonArray"></a>toSafeJsonArray
 
 [**@xylabs/object**](#../../README)
@@ -569,29 +556,27 @@ function toSafeJson(value, maxDepth?): unknown;
 
 ```ts
 function toSafeJsonArray(
-   value, 
-   cycleList?, 
-   maxDepth?): unknown[];
+   value: unknown[], 
+   cycleList?: unknown[], 
+   maxDepth?: number): unknown[];
 ```
 
-## Parameters
-
-### value
-
-`unknown`[]
-
-### cycleList?
-
-`unknown`[]
+Converts an array to a JSON-safe array, handling circular references and depth limits.
 
-### maxDepth?
+## Parameters
 
-`number` = `3`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `value` | `unknown`[] | `undefined` | The array to convert. |
+| `cycleList?` | `unknown`[] | `undefined` | Tracks visited objects to detect circular references. |
+| `maxDepth?` | `number` | `3` | Maximum recursion depth before truncating. |
 
 ## Returns
 
 `unknown`[]
 
+A JSON-safe array representation.
+
     ### <a id="toSafeJsonObject"></a>toSafeJsonObject
 
 [**@xylabs/object**](#../../README)
@@ -600,29 +585,27 @@ function toSafeJsonArray(
 
 ```ts
 function toSafeJsonObject(
-   value, 
-   cycleList?, 
-   maxDepth?): JsonObject;
+   value: object, 
+   cycleList?: unknown[], 
+   maxDepth?: number): JsonObject;
 ```
 
-## Parameters
-
-### value
-
-`object`
+Converts an object to a JSON-safe object, handling circular references and depth limits.
 
-### cycleList?
-
-`unknown`[]
-
-### maxDepth?
+## Parameters
 
-`number` = `3`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `value` | `object` | `undefined` | The object to convert. |
+| `cycleList?` | `unknown`[] | `undefined` | Tracks visited objects to detect circular references. |
+| `maxDepth?` | `number` | `3` | Maximum recursion depth before truncating. |
 
 ## Returns
 
 [`JsonObject`](#../type-aliases/JsonObject)
 
+A JSON-safe object representation.
+
     ### <a id="toSafeJsonString"></a>toSafeJsonString
 
 [**@xylabs/object**](#../../README)
@@ -630,23 +613,24 @@ function toSafeJsonObject(
 ***
 
 ```ts
-function toSafeJsonString(value, maxDepth?): string;
+function toSafeJsonString(value: unknown, maxDepth?: number): string;
 ```
 
-## Parameters
-
-### value
-
-`unknown`
+Converts a value to a pretty-printed JSON string, safely handling circular references and non-JSON types.
 
-### maxDepth?
+## Parameters
 
-`number` = `3`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `value` | `unknown` | `undefined` | The value to serialize. |
+| `maxDepth` | `number` | `3` | Maximum recursion depth. |
 
 ## Returns
 
 `string`
 
+A formatted JSON string.
+
     ### <a id="toSafeJsonValue"></a>toSafeJsonValue
 
 [**@xylabs/object**](#../../README)
@@ -655,29 +639,28 @@ function toSafeJsonString(value, maxDepth?): string;
 
 ```ts
 function toSafeJsonValue(
-   value, 
-   cycleList?, 
-   maxDepth?): unknown;
+   value: unknown, 
+   cycleList?: unknown[], 
+   maxDepth?: number): unknown;
 ```
 
-## Parameters
-
-### value
+Converts an unknown value to a JSON-safe value, replacing circular references with '[Circular]' and
+non-JSON types with descriptive placeholder strings.
 
-`unknown`
-
-### cycleList?
-
-`unknown`[]
-
-### maxDepth?
+## Parameters
 
-`number` = `3`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `value` | `unknown` | `undefined` | The value to convert. |
+| `cycleList?` | `unknown`[] | `undefined` | Tracks visited objects to detect circular references. |
+| `maxDepth?` | `number` | `3` | Maximum recursion depth before truncating with '[MaxDepth]'. |
 
 ## Returns
 
 `unknown`
 
+A JSON-safe representation of the value.
+
   ### interfaces
 
     ### <a id="ObjectTypeConfig"></a>ObjectTypeConfig
@@ -686,21 +669,17 @@ function toSafeJsonValue(
 
 ***
 
+Configuration options for object type checking.
+
 ## Extends
 
 - [`TypeCheckConfig`](#TypeCheckConfig)
 
 ## Properties
 
-### log?
-
-```ts
-optional log: boolean | Logger;
-```
-
-### Inherited from
-
-[`TypeCheckConfig`](#TypeCheckConfig).[`log`](TypeCheckConfig.md#log)
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="log"></a> `log?` | `boolean` \| `Logger` | [`TypeCheckConfig`](#TypeCheckConfig).[`log`](TypeCheckConfig.md#log) |
 
     ### <a id="TypeCheckConfig"></a>TypeCheckConfig
 
@@ -708,6 +687,8 @@ optional log: boolean | Logger;
 
 ***
 
+Configuration options for type check functions, with optional logging.
+
 ## Extended by
 
 - [`ObjectTypeConfig`](#ObjectTypeConfig)
@@ -716,11 +697,9 @@ optional log: boolean | Logger;
 
 ## Properties
 
-### log?
-
-```ts
-optional log: boolean | Logger;
-```
+| Property | Type |
+| ------ | ------ |
+| <a id="log"></a> `log?` | `boolean` \| `Logger` |
 
     ### <a id="TypeCheckOptionalConfig"></a>TypeCheckOptionalConfig
 
@@ -728,29 +707,18 @@ optional log: boolean | Logger;
 
 ***
 
+Type check configuration that marks the value as optional, returning undefined on failure.
+
 ## Extends
 
 - [`TypeCheckConfig`](#TypeCheckConfig)
 
 ## Properties
 
-### log?
-
-```ts
-optional log: boolean | Logger;
-```
-
-### Inherited from
-
-[`TypeCheckConfig`](#TypeCheckConfig).[`log`](TypeCheckConfig.md#log)
-
-***
-
-### required
-
-```ts
-required: false;
-```
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="log"></a> `log?` | `boolean` \| `Logger` | [`TypeCheckConfig`](#TypeCheckConfig).[`log`](TypeCheckConfig.md#log) |
+| <a id="required"></a> `required` | `false` | - |
 
     ### <a id="TypeCheckRequiredConfig"></a>TypeCheckRequiredConfig
 
@@ -758,29 +726,18 @@ required: false;
 
 ***
 
+Type check configuration that marks the value as required, causing assertions on failure.
+
 ## Extends
 
 - [`TypeCheckConfig`](#TypeCheckConfig)
 
 ## Properties
 
-### log?
-
-```ts
-optional log: boolean | Logger;
-```
-
-### Inherited from
-
-[`TypeCheckConfig`](#TypeCheckConfig).[`log`](TypeCheckConfig.md#log)
-
-***
-
-### required
-
-```ts
-required: true;
-```
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="log"></a> `log?` | `boolean` \| `Logger` | [`TypeCheckConfig`](#TypeCheckConfig).[`log`](TypeCheckConfig.md#log) |
+| <a id="required"></a> `required` | `true` | - |
 
     ### <a id="Validator"></a>Validator
 
@@ -788,25 +745,27 @@ required: true;
 
 ***
 
-## Type Parameters
+Interface for validating objects and returning any errors found.
 
-### T
+## Type Parameters
 
-`T` *extends* [`EmptyObject`](#../type-aliases/EmptyObject) = [`AnyObject`](#../type-aliases/AnyObject)
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* [`EmptyObject`](#../type-aliases/EmptyObject) | [`AnyObject`](#../type-aliases/AnyObject) |
 
 ## Methods
 
 ### validate()
 
 ```ts
-validate(payload): Promisable<Error[]>;
+validate(payload: T): Promisable<Error[]>;
 ```
 
 ### Parameters
 
-#### payload
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `payload` | `T` |
 
 ### Returns
 
@@ -834,26 +793,28 @@ will result in a type that includes the universal set of field names
 ***
 
 ```ts
-type AsOptionalTypeFunction<T> = <TType>(value) => TType | undefined;
+type AsOptionalTypeFunction<T> = <TType>(value: AnyNonPromise) => TType | undefined;
 ```
 
-## Type Parameters
+A simplified type-narrowing function that returns T or undefined, without assertion support.
 
-### T
+## Type Parameters
 
-`T` *extends* `AnyNonPromise` = `AnyNonPromise`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `AnyNonPromise` | `AnyNonPromise` |
 
 ## Type Parameters
 
-### TType
-
-`TType` *extends* `AnyNonPromise`
+| Type Parameter |
+| ------ |
+| `TType` *extends* `AnyNonPromise` |
 
 ## Parameters
 
-### value
-
-`AnyNonPromise`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `AnyNonPromise` |
 
 ## Returns
 
@@ -867,38 +828,44 @@ type AsOptionalTypeFunction<T> = <TType>(value) => TType | undefined;
 
 ```ts
 type AsTypeFunction<T> = {
-<TType>  (value): TType | undefined;
-<TType>  (value, config): TType;
-<TType>  (value, config): TType | undefined;
-<TType>  (value, assert): TType | undefined;
-<TType>  (value, assert, config): TType;
-<TType>  (value, assert, config): TType | undefined;
+<TType>  (value: AnyNonPromise): TType | undefined;
+<TType>  (value: AnyNonPromise, config: TypeCheckRequiredConfig): TType;
+<TType>  (value: AnyNonPromise, config: 
+  | TypeCheckConfig
+  | TypeCheckOptionalConfig): TType | undefined;
+<TType>  (value: AnyNonPromise, assert: StringOrAlertFunction<TType>): TType | undefined;
+<TType>  (value: AnyNonPromise, assert: StringOrAlertFunction<TType>, config: TypeCheckRequiredConfig): TType;
+<TType>  (value: AnyNonPromise, assert: StringOrAlertFunction<TType>, config: 
+  | TypeCheckConfig
+  | TypeCheckOptionalConfig): TType | undefined;
 };
 ```
 
-## Type Parameters
+A type-narrowing function that attempts to cast a value to T, with optional assertion and configuration overloads.
 
-### T
+## Type Parameters
 
-`T` *extends* `AnyNonPromise` = `AnyNonPromise`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `AnyNonPromise` | `AnyNonPromise` |
 
 ## Call Signature
 
 ```ts
-<TType>(value): TType | undefined;
+<TType>(value: AnyNonPromise): TType | undefined;
 ```
 
 ### Type Parameters
 
-### TType
-
-`TType` *extends* `AnyNonPromise`
+| Type Parameter |
+| ------ |
+| `TType` *extends* `AnyNonPromise` |
 
 ### Parameters
 
-### value
-
-`AnyNonPromise`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `AnyNonPromise` |
 
 ### Returns
 
@@ -907,24 +874,21 @@ type AsTypeFunction<T> = {
 ## Call Signature
 
 ```ts
-<TType>(value, config): TType;
+<TType>(value: AnyNonPromise, config: TypeCheckRequiredConfig): TType;
 ```
 
 ### Type Parameters
 
-### TType
-
-`TType` *extends* `AnyNonPromise`
+| Type Parameter |
+| ------ |
+| `TType` *extends* `AnyNonPromise` |
 
 ### Parameters
 
-### value
-
-`AnyNonPromise`
-
-### config
-
-[`TypeCheckRequiredConfig`](#../interfaces/TypeCheckRequiredConfig)
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `AnyNonPromise` |
+| `config` | [`TypeCheckRequiredConfig`](#../interfaces/TypeCheckRequiredConfig) |
 
 ### Returns
 
@@ -933,24 +897,23 @@ type AsTypeFunction<T> = {
 ## Call Signature
 
 ```ts
-<TType>(value, config): TType | undefined;
+<TType>(value: AnyNonPromise, config: 
+  | TypeCheckConfig
+  | TypeCheckOptionalConfig): TType | undefined;
 ```
 
 ### Type Parameters
 
-### TType
-
-`TType` *extends* `AnyNonPromise`
+| Type Parameter |
+| ------ |
+| `TType` *extends* `AnyNonPromise` |
 
 ### Parameters
 
-### value
-
-`AnyNonPromise`
-
-### config
-
-[`TypeCheckConfig`](#../interfaces/TypeCheckConfig) | [`TypeCheckOptionalConfig`](#../interfaces/TypeCheckOptionalConfig)
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `AnyNonPromise` |
+| `config` | \| [`TypeCheckConfig`](#../interfaces/TypeCheckConfig) \| [`TypeCheckOptionalConfig`](#../interfaces/TypeCheckOptionalConfig) |
 
 ### Returns
 
@@ -959,24 +922,21 @@ type AsTypeFunction<T> = {
 ## Call Signature
 
 ```ts
-<TType>(value, assert): TType | undefined;
+<TType>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>): TType | undefined;
 ```
 
 ### Type Parameters
 
-### TType
-
-`TType` *extends* `AnyNonPromise`
+| Type Parameter |
+| ------ |
+| `TType` *extends* `AnyNonPromise` |
 
 ### Parameters
 
-### value
-
-`AnyNonPromise`
-
-### assert
-
-[`StringOrAlertFunction`](#StringOrAlertFunction)\<`TType`\>
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `AnyNonPromise` |
+| `assert` | [`StringOrAlertFunction`](#StringOrAlertFunction)\<`TType`\> |
 
 ### Returns
 
@@ -986,30 +946,24 @@ type AsTypeFunction<T> = {
 
 ```ts
 <TType>(
-   value, 
-   assert, 
-   config): TType;
+   value: AnyNonPromise, 
+   assert: StringOrAlertFunction<TType>, 
+   config: TypeCheckRequiredConfig): TType;
 ```
 
 ### Type Parameters
 
-### TType
-
-`TType` *extends* `AnyNonPromise`
+| Type Parameter |
+| ------ |
+| `TType` *extends* `AnyNonPromise` |
 
 ### Parameters
 
-### value
-
-`AnyNonPromise`
-
-### assert
-
-[`StringOrAlertFunction`](#StringOrAlertFunction)\<`TType`\>
-
-### config
-
-[`TypeCheckRequiredConfig`](#../interfaces/TypeCheckRequiredConfig)
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `AnyNonPromise` |
+| `assert` | [`StringOrAlertFunction`](#StringOrAlertFunction)\<`TType`\> |
+| `config` | [`TypeCheckRequiredConfig`](#../interfaces/TypeCheckRequiredConfig) |
 
 ### Returns
 
@@ -1019,30 +973,26 @@ type AsTypeFunction<T> = {
 
 ```ts
 <TType>(
-   value, 
-   assert, 
-   config): TType | undefined;
+   value: AnyNonPromise, 
+   assert: StringOrAlertFunction<TType>, 
+   config: 
+  | TypeCheckConfig
+  | TypeCheckOptionalConfig): TType | undefined;
 ```
 
 ### Type Parameters
 
-### TType
-
-`TType` *extends* `AnyNonPromise`
+| Type Parameter |
+| ------ |
+| `TType` *extends* `AnyNonPromise` |
 
 ### Parameters
 
-### value
-
-`AnyNonPromise`
-
-### assert
-
-[`StringOrAlertFunction`](#StringOrAlertFunction)\<`TType`\>
-
-### config
-
-[`TypeCheckConfig`](#../interfaces/TypeCheckConfig) | [`TypeCheckOptionalConfig`](#../interfaces/TypeCheckOptionalConfig)
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `AnyNonPromise` |
+| `assert` | [`StringOrAlertFunction`](#StringOrAlertFunction)\<`TType`\> |
+| `config` | \| [`TypeCheckConfig`](#../interfaces/TypeCheckConfig) \| [`TypeCheckOptionalConfig`](#../interfaces/TypeCheckOptionalConfig) |
 
 ### Returns
 
@@ -1055,24 +1005,23 @@ type AsTypeFunction<T> = {
 ***
 
 ```ts
-type Compare<T> = (a, b) => number;
+type Compare<T> = (a: T, b: T) => number;
 ```
 
+A comparator function that returns a negative number if a < b, zero if a == b, and a positive number if a > b.
+
 ## Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ## Parameters
 
-### a
-
-`T`
-
-### b
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `a` | `T` |
+| `b` | `T` |
 
 ## Returns
 
@@ -1088,15 +1037,14 @@ type Compare<T> = (a, b) => number;
 type DeepOmitStartsWith<T, Prefix> = T extends infer U[] ? DeepOmitStartsWith<U, Prefix>[] : T extends object ? { [K in keyof T as K extends string ? K extends `${Prefix}${string}` ? never : K : K]: DeepOmitStartsWith<T[K], Prefix> } : T;
 ```
 
-## Type Parameters
-
-### T
-
-`T`
+Recursively omits keys that start with the given prefix, including in nested objects and arrays.
 
-### Prefix
+## Type Parameters
 
-`Prefix` *extends* `string`
+| Type Parameter |
+| ------ |
+| `T` |
+| `Prefix` *extends* `string` |
 
     ### <a id="DeepPickStartsWith"></a>DeepPickStartsWith
 
@@ -1108,15 +1056,14 @@ type DeepOmitStartsWith<T, Prefix> = T extends infer U[] ? DeepOmitStartsWith<U,
 type DeepPickStartsWith<T, Prefix> = T extends infer U[] ? DeepPickStartsWith<U, Prefix>[] : T extends object ? { [K in keyof T as K extends string ? K extends `${Prefix}${string}` ? K : never : K]: DeepPickStartsWith<T[K], Prefix> } : T;
 ```
 
-## Type Parameters
-
-### T
+Recursively picks only the keys that start with the given prefix, including in nested objects and arrays.
 
-`T`
-
-### Prefix
+## Type Parameters
 
-`Prefix` *extends* `string`
+| Type Parameter |
+| ------ |
+| `T` |
+| `Prefix` *extends* `string` |
 
     ### <a id="DeepRestrictToJson"></a>DeepRestrictToJson
 
@@ -1128,11 +1075,13 @@ type DeepPickStartsWith<T, Prefix> = T extends infer U[] ? DeepPickStartsWith<U,
 type DeepRestrictToJson<T> = { [K in keyof T as K extends string ? K : never]: T[K] extends (infer U)[] ? DeepRestrictToJson<U>[] : T[K] extends object ? DeepRestrictToJson<T[K]> : T[K] extends JsonValue ? T[K] : never };
 ```
 
-## Type Parameters
+Recursively restricts an object type to only JSON-compatible values, excluding non-serializable types.
 
-### T
+## Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
     ### <a id="DeepRestrictToStringKeys"></a>DeepRestrictToStringKeys
 
@@ -1144,11 +1093,13 @@ type DeepRestrictToJson<T> = { [K in keyof T as K extends string ? K : never]: T
 type DeepRestrictToStringKeys<T> = { [K in keyof T as K extends string ? K : never]: T[K] extends (infer U)[] ? DeepRestrictToStringKeys<U>[] : T[K] extends object ? DeepRestrictToStringKeys<T[K]> : T[K] };
 ```
 
+Recursively removes all non-string keys from an object type, including in nested objects and arrays.
+
 ## Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
     ### <a id="EmptyObject"></a>EmptyObject
 
@@ -1157,7 +1108,7 @@ type DeepRestrictToStringKeys<T> = { [K in keyof T as K extends string ? K : nev
 ***
 
 ```ts
-type EmptyObject<T> = Exclude<{ [K in keyof T]?: never }, unknown[] | (...args) => unknown | null>;
+type EmptyObject<T> = Exclude<{ [K in keyof T]?: never }, unknown[] | (...args: unknown[]) => unknown | null>;
 ```
 
 An empty object, which means that it does enforce the set of field names, defaulting to an empty set until
@@ -1165,9 +1116,9 @@ extended from, which then adds only those additional fields
 
 ## Type Parameters
 
-### T
-
-`T` *extends* `object` = `object`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `object` | `object` |
 
     ### <a id="JsonArray"></a>JsonArray
 
@@ -1179,6 +1130,8 @@ extended from, which then adds only those additional fields
 type JsonArray = z.infer<typeof JsonArrayZod>;
 ```
 
+A JSON array containing JSON values.
+
     ### <a id="JsonObject"></a>JsonObject
 
 [**@xylabs/object**](#../../README)
@@ -1189,6 +1142,8 @@ type JsonArray = z.infer<typeof JsonArrayZod>;
 type JsonObject = z.infer<typeof JsonObjectZod>;
 ```
 
+A JSON object with string keys and JSON values.
+
     ### <a id="JsonValue"></a>JsonValue
 
 [**@xylabs/object**](#../../README)
@@ -1199,6 +1154,8 @@ type JsonObject = z.infer<typeof JsonObjectZod>;
 type JsonValue = z.infer<typeof JsonValueZod>;
 ```
 
+A recursive JSON value: string, number, boolean, null, array, or object.
+
     ### <a id="OmitByPredicate"></a>OmitByPredicate
 
 [**@xylabs/object**](#../../README)
@@ -1206,24 +1163,23 @@ type JsonValue = z.infer<typeof JsonValueZod>;
 ***
 
 ```ts
-type OmitByPredicate<T> = (value, key) => boolean;
+type OmitByPredicate<T> = (value: T[keyof T], key: keyof T) => boolean;
 ```
 
-## Type Parameters
+A predicate function used to determine which properties to omit from an object.
 
-### T
+## Type Parameters
 
-`T` *extends* [`EmptyObject`](#EmptyObject) = `Record`\<`string`, `unknown`\>
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* [`EmptyObject`](#EmptyObject) | `Record`\<`string`, `unknown`\> |
 
 ## Parameters
 
-### value
-
-`T`\[keyof `T`\]
-
-### key
-
-keyof `T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T`\[keyof `T`\] |
+| `key` | keyof `T` |
 
 ## Returns
 
@@ -1239,15 +1195,14 @@ keyof `T`
 type OmitStartsWith<T, Prefix> = { [K in keyof T as K extends `${Prefix}${string}` ? never : K]: T[K] };
 ```
 
-## Type Parameters
+Omits the keys of T that start with the given prefix.
 
-### T
-
-`T`
-
-### Prefix
+## Type Parameters
 
-`Prefix` *extends* `string`
+| Type Parameter |
+| ------ |
+| `T` |
+| `Prefix` *extends* `string` |
 
     ### <a id="Optional"></a>Optional
 
@@ -1259,15 +1214,14 @@ type OmitStartsWith<T, Prefix> = { [K in keyof T as K extends `${Prefix}${string
 type Optional<T, F> = Omit<T, F> & Partial<Pick<T, F>>;
 ```
 
-## Type Parameters
-
-### T
-
-`T` *extends* `object`
+Makes the specified fields of T optional while keeping the rest required.
 
-### F
+## Type Parameters
 
-`F` *extends* keyof `T`
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |
+| `F` *extends* keyof `T` |
 
     ### <a id="Override"></a>Override
 
@@ -1279,15 +1233,14 @@ type Optional<T, F> = Omit<T, F> & Partial<Pick<T, F>>;
 type Override<T1, T2> = Omit<T1, keyof T2> & T2;
 ```
 
-## Type Parameters
-
-### T1
-
-`T1`
+Overrides properties of T1 with those from T2.
 
-### T2
+## Type Parameters
 
-`T2`
+| Type Parameter |
+| ------ |
+| `T1` |
+| `T2` |
 
     ### <a id="PartialRecord"></a>PartialRecord
 
@@ -1301,13 +1254,10 @@ type PartialRecord<K, T> = { [P in K]?: T };
 
 ## Type Parameters
 
-### K
-
-`K` *extends* keyof `any`
-
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `K` *extends* keyof `any` |
+| `T` |
 
 ## Deprecated
 
@@ -1320,24 +1270,23 @@ use Partial<Record<>> instead
 ***
 
 ```ts
-type PickByPredicate<T> = (value, key) => boolean;
+type PickByPredicate<T> = (value: T[keyof T], key: keyof T) => boolean;
 ```
 
-## Type Parameters
+A predicate function used to determine which properties to pick from an object.
 
-### T
+## Type Parameters
 
-`T` *extends* [`EmptyObject`](#EmptyObject) = `Record`\<`string`, `unknown`\>
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* [`EmptyObject`](#EmptyObject) | `Record`\<`string`, `unknown`\> |
 
 ## Parameters
 
-### value
-
-`T`\[keyof `T`\]
-
-### key
-
-keyof `T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T`\[keyof `T`\] |
+| `key` | keyof `T` |
 
 ## Returns
 
@@ -1353,15 +1302,14 @@ keyof `T`
 type PickStartsWith<T, Prefix> = { [K in keyof T as K extends `${Prefix}${string}` ? K : never]: T[K] };
 ```
 
-## Type Parameters
-
-### T
-
-`T`
+Picks only the keys of T that start with the given prefix.
 
-### Prefix
+## Type Parameters
 
-`Prefix` *extends* `string`
+| Type Parameter |
+| ------ |
+| `T` |
+| `Prefix` *extends* `string` |
 
     ### <a id="Simplify"></a>Simplify
 
@@ -1370,14 +1318,17 @@ type PickStartsWith<T, Prefix> = { [K in keyof T as K extends `${Prefix}${string
 ***
 
 ```ts
-type Simplify<T> = { [K in keyof T]: T[K] } & object;
+type Simplify<T> = { [K in keyof T]: T[K] } & {
+};
 ```
 
-## Type Parameters
+Flattens an intersection or complex mapped type into a single object type for better readability.
 
-### T
+## Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
     ### <a id="StringKeyObject"></a>StringKeyObject
 
@@ -1386,14 +1337,18 @@ type Simplify<T> = { [K in keyof T]: T[K] } & object;
 ***
 
 ```ts
-type StringKeyObject<T> = object;
+type StringKeyObject<T> = {
+[key: string]: T;
+};
 ```
 
-## Type Parameters
+An object type with string keys and values of type T.
 
-### T
+## Type Parameters
 
-`T` = `unknown`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` | `unknown` |
 
 ## Index Signature
 
@@ -1411,11 +1366,13 @@ type StringKeyObject<T> = object;
 type StringOrAlertFunction<T> = string | AssertExMessageFunc<T>;
 ```
 
-## Type Parameters
+A string message or function that produces an assertion error message for a failed type check.
 
-### T
+## Type Parameters
 
-`T` *extends* `AnyNonPromise`
+| Type Parameter |
+| ------ |
+| `T` *extends* `AnyNonPromise` |
 
     ### <a id="TypeCheck"></a>TypeCheck
 
@@ -1425,29 +1382,34 @@ type StringOrAlertFunction<T> = string | AssertExMessageFunc<T>;
 
 ```ts
 type TypeCheck<T> = {
-  (obj): obj is T;
-  (obj, config): obj is T;
-  (obj, config): obj is T;
+  (obj: AnyNonPromise): obj is T;
+  (obj: AnyNonPromise, config: TypeCheckConfig): obj is T;
+  (obj: AnyNonPromise, config: 
+  | number
+  | TypeCheckConfig
+  | undefined): obj is T;
 };
 ```
 
-## Type Parameters
+A type guard function that checks whether a value conforms to type T, with optional configuration.
 
-### T
+## Type Parameters
 
-`T` *extends* `TypedValue`
+| Type Parameter |
+| ------ |
+| `T` *extends* `TypedValue` |
 
 ## Call Signature
 
 ```ts
-(obj): obj is T;
+(obj: AnyNonPromise): obj is T;
 ```
 
 ### Parameters
 
-### obj
-
-`AnyNonPromise`
+| Parameter | Type |
+| ------ | ------ |
+| `obj` | `AnyNonPromise` |
 
 ### Returns
 
@@ -1456,18 +1418,15 @@ type TypeCheck<T> = {
 ## Call Signature
 
 ```ts
-(obj, config): obj is T;
+(obj: AnyNonPromise, config: TypeCheckConfig): obj is T;
 ```
 
 ### Parameters
 
-### obj
-
-`AnyNonPromise`
-
-### config
-
-[`TypeCheckConfig`](#../interfaces/TypeCheckConfig)
+| Parameter | Type |
+| ------ | ------ |
+| `obj` | `AnyNonPromise` |
+| `config` | [`TypeCheckConfig`](#../interfaces/TypeCheckConfig) |
 
 ### Returns
 
@@ -1476,18 +1435,18 @@ type TypeCheck<T> = {
 ## Call Signature
 
 ```ts
-(obj, config): obj is T;
+(obj: AnyNonPromise, config: 
+  | number
+  | TypeCheckConfig
+  | undefined): obj is T;
 ```
 
 ### Parameters
 
-### obj
-
-`AnyNonPromise`
-
-### config
-
-`number` | [`TypeCheckConfig`](#../interfaces/TypeCheckConfig) | `undefined`
+| Parameter | Type |
+| ------ | ------ |
+| `obj` | `AnyNonPromise` |
+| `config` | \| `number` \| [`TypeCheckConfig`](#../interfaces/TypeCheckConfig) \| `undefined` |
 
 ### Returns
 
@@ -1503,15 +1462,14 @@ type TypeCheck<T> = {
 type WithAdditional<T, TAdditional> = TAdditional extends EmptyObject ? T & TAdditional : T;
 ```
 
-## Type Parameters
-
-### T
+Intersects T with TAdditional if TAdditional is an object, otherwise returns T unchanged.
 
-`T` *extends* [`EmptyObject`](#EmptyObject) \| `void`
-
-### TAdditional
+## Type Parameters
 
-`TAdditional` *extends* [`EmptyObject`](#EmptyObject) \| `void` = `void`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* [`EmptyObject`](#EmptyObject) \| `void` | - |
+| `TAdditional` *extends* [`EmptyObject`](#EmptyObject) \| `void` | `void` |
 
   ### variables
 
@@ -1522,66 +1480,20 @@ type WithAdditional<T, TAdditional> = TAdditional extends EmptyObject ? T & TAdd
 ***
 
 ```ts
-const AsObjectFactory: object;
-```
-
-## Type Declaration
-
-### create()
-
-```ts
-create: <T>(typeCheck) => AsTypeFunction<T>;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `TypedObject`
-
-### Parameters
-
-#### typeCheck
-
-[`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>
-
-### Returns
-
-[`AsTypeFunction`](#../type-aliases/AsTypeFunction)\<`T`\>
-
-### createOptional()
-
-```ts
-createOptional: <T>(typeCheck) => (value) => T | undefined;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `TypedObject`
-
-### Parameters
-
-#### typeCheck
-
-[`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>
-
-### Returns
-
-```ts
-(value): T | undefined;
+const AsObjectFactory: {
+  create: <T>(typeCheck: TypeCheck<T>) => AsTypeFunction<T>;
+  createOptional: <T>(typeCheck: TypeCheck<T>) => (value: AnyNonPromise) => T | undefined;
+};
 ```
 
-#### Parameters
-
-##### value
+Factory for creating type-narrowing functions for TypedObject types.
 
-`AnyNonPromise`
-
-#### Returns
+## Type Declaration
 
-`T` \| `undefined`
+| Name | Type |
+| ------ | ------ |
+| <a id="property-create"></a> `create()` | \<`T`\>(`typeCheck`: [`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>) => [`AsTypeFunction`](#../type-aliases/AsTypeFunction)\<`T`\> |
+| <a id="property-createoptional"></a> `createOptional()` | \<`T`\>(`typeCheck`: [`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>) => (`value`: `AnyNonPromise`) => `T` \| `undefined` |
 
     ### <a id="AsTypeFactory"></a>AsTypeFactory
 
@@ -1590,66 +1502,21 @@ createOptional: <T>(typeCheck) => (value) => T | undefined;
 ***
 
 ```ts
-const AsTypeFactory: object;
-```
-
-## Type Declaration
-
-### create()
-
-```ts
-create: <T>(typeCheck) => AsTypeFunction<T>;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `AnyNonPromise`
-
-### Parameters
-
-#### typeCheck
-
-[`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>
-
-### Returns
-
-[`AsTypeFunction`](#../type-aliases/AsTypeFunction)\<`T`\>
-
-### createOptional()
-
-```ts
-createOptional: <T>(typeCheck) => (value) => T | undefined;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `AnyNonPromise`
-
-### Parameters
-
-#### typeCheck
-
-[`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>
-
-### Returns
-
-```ts
-(value): T | undefined;
+const AsTypeFactory: {
+  create: <T>(typeCheck: TypeCheck<T>) => AsTypeFunction<T>;
+  createOptional: <T>(typeCheck: TypeCheck<T>) => (value: AnyNonPromise) => T | undefined;
+};
 ```
 
-#### Parameters
-
-##### value
+Factory for creating type-narrowing 'as' functions that cast a value to T or return undefined.
+Supports optional assertion messages and configuration for required/optional behavior.
 
-`AnyNonPromise`
-
-#### Returns
+## Type Declaration
 
-`T` \| `undefined`
+| Name | Type |
+| ------ | ------ |
+| <a id="property-create"></a> `create()` | \<`T`\>(`typeCheck`: [`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>) => [`AsTypeFunction`](#../type-aliases/AsTypeFunction)\<`T`\> |
+| <a id="property-createoptional"></a> `createOptional()` | \<`T`\>(`typeCheck`: [`TypeCheck`](#../type-aliases/TypeCheck)\<`T`\>) => (`value`: `AnyNonPromise`) => `T` \| `undefined` |
 
     ### <a id="JsonObjectZod"></a>JsonObjectZod
 
@@ -1661,6 +1528,8 @@ createOptional: <T>(typeCheck) => (value) => T | undefined;
 const JsonObjectZod: ZodRecord<ZodString, ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>;
 ```
 
+Zod schema for a JSON object with string keys and recursive JSON values.
+
     ### <a id="asAnyObject"></a>asAnyObject
 
 [**@xylabs/object**](#../../README)
@@ -1671,6 +1540,8 @@ const JsonObjectZod: ZodRecord<ZodString, ZodType<unknown, unknown, $ZodTypeInte
 const asAnyObject: AsTypeFunction<AnyObject>;
 ```
 
+Type-narrowing function that casts a value to AnyObject if it is a plain object, or returns undefined.
+
     ### <a id="asJsonArray"></a>asJsonArray
 
 [**@xylabs/object**](#../../README)
@@ -1679,28 +1550,30 @@ const asAnyObject: AsTypeFunction<AnyObject>;
 
 ```ts
 const asJsonArray: {
-<T>  (value): T & unknown[] | undefined;
-<T>  (value, assert): T & unknown[];
+<T>  (value: T): T & unknown[] | undefined;
+<T>  (value: T, assert: ZodFactoryConfig): T & unknown[];
 };
 ```
 
+Casts a value to JsonArray or returns undefined if it does not conform.
+
 ## Call Signature
 
 ```ts
-<T>(value): T & unknown[] | undefined;
+<T>(value: T): T & unknown[] | undefined;
 ```
 
 ### Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1709,24 +1582,21 @@ const asJsonArray: {
 ## Call Signature
 
 ```ts
-<T>(value, assert): T & unknown[];
+<T>(value: T, assert: ZodFactoryConfig): T & unknown[];
 ```
 
 ### Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
-
-### assert
-
-`ZodFactoryConfig`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
+| `assert` | `ZodFactoryConfig` |
 
 ### Returns
 
@@ -1740,28 +1610,30 @@ const asJsonArray: {
 
 ```ts
 const asJsonObject: {
-<T>  (value): T & Record<string, unknown> | undefined;
-<T>  (value, assert): T & Record<string, unknown>;
+<T>  (value: T): T & Record<string, unknown> | undefined;
+<T>  (value: T, assert: ZodFactoryConfig): T & Record<string, unknown>;
 };
 ```
 
+Casts a value to JsonObject or returns undefined if it does not conform.
+
 ## Call Signature
 
 ```ts
-<T>(value): T & Record<string, unknown> | undefined;
+<T>(value: T): T & Record<string, unknown> | undefined;
 ```
 
 ### Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1770,24 +1642,21 @@ const asJsonObject: {
 ## Call Signature
 
 ```ts
-<T>(value, assert): T & Record<string, unknown>;
+<T>(value: T, assert: ZodFactoryConfig): T & Record<string, unknown>;
 ```
 
 ### Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
-
-### assert
-
-`ZodFactoryConfig`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
+| `assert` | `ZodFactoryConfig` |
 
 ### Returns
 
@@ -1801,28 +1670,30 @@ const asJsonObject: {
 
 ```ts
 const asJsonValue: {
-<T>  (value): T | undefined;
-<T>  (value, assert): T;
+<T>  (value: T): T | undefined;
+<T>  (value: T, assert: ZodFactoryConfig): T;
 };
 ```
 
+Casts a value to JsonValue or returns undefined if it does not conform.
+
 ## Call Signature
 
 ```ts
-<T>(value): T | undefined;
+<T>(value: T): T | undefined;
 ```
 
 ### Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -1831,24 +1702,21 @@ const asJsonValue: {
 ## Call Signature
 
 ```ts
-<T>(value, assert): T;
+<T>(value: T, assert: ZodFactoryConfig): T;
 ```
 
 ### Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
-
-### assert
-
-`ZodFactoryConfig`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
+| `assert` | `ZodFactoryConfig` |
 
 ### Returns
 
@@ -1861,31 +1729,22 @@ const asJsonValue: {
 ***
 
 ```ts
-const deepMerge: <T>(...objects) => MergeAll<T>;
+const deepMerge: <T>(...objects: T) => MergeAll<T>;
 ```
 
 Deeply merges multiple objects into a new object.
 
 ## Type Parameters
 
-### T
-
-`T` *extends* [`AnyObject`](#../type-aliases/AnyObject)[]
+| Type Parameter |
+| ------ |
+| `T` *extends* [`AnyObject`](#../type-aliases/AnyObject)[] |
 
 ## Parameters
 
-### objects
-
-...`T`
-
-Multiple objects to merge deeply.
-The function merges properties from all objects into a new object.
-If a property exists in multiple objects, the last object's value will be used.
-If a property is an object, it will be merged recursively.
-If a property is an array, it will be overwritten by the last object's value.
-If a property is a primitive value, it will be overwritten by the last object's value.
-If a property is undefined in the source, it will be skipped.
-If a property is a symbol, it will be merged as well.
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| ...`objects` | `T` | Multiple objects to merge deeply. The function merges properties from all objects into a new object. If a property exists in multiple objects, the last object's value will be used. If a property is an object, it will be merged recursively. If a property is an array, it will be overwritten by the last object's value. If a property is a primitive value, it will be overwritten by the last object's value. If a property is undefined in the source, it will be skipped. If a property is a symbol, it will be merged as well. |
 
 ## Returns
 
@@ -1900,20 +1759,22 @@ A new object with the merged properties.
 ***
 
 ```ts
-const isJsonArray: <T>(value) => value is T & unknown[];
+const isJsonArray: <T>(value: T) => value is T & unknown[];
 ```
 
-## Type Parameters
+Type guard that checks if a value is a valid JSON array.
 
-### T
+## Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ## Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ## Returns
 
@@ -1926,20 +1787,22 @@ const isJsonArray: <T>(value) => value is T & unknown[];
 ***
 
 ```ts
-const isJsonObject: <T>(value) => value is T & Record<string, unknown>;
+const isJsonObject: <T>(value: T) => value is T & Record<string, unknown>;
 ```
 
-## Type Parameters
+Type guard that checks if a value is a valid JSON object.
 
-### T
+## Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ## Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ## Returns
 
@@ -1952,20 +1815,22 @@ const isJsonObject: <T>(value) => value is T & Record<string, unknown>;
 ***
 
 ```ts
-const isJsonValue: <T>(value) => value is T;
+const isJsonValue: <T>(value: T) => value is T;
 ```
 
-## Type Parameters
+Type guard that checks if a value is a valid JSON value.
 
-### T
+## Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ## Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ## Returns
 
@@ -1979,28 +1844,30 @@ const isJsonValue: <T>(value) => value is T;
 
 ```ts
 const toJsonArray: {
-<T>  (value): T & unknown[] | undefined;
-<T>  (value, assert): T & unknown[];
+<T>  (value: T): T & unknown[] | undefined;
+<T>  (value: T, assert: ZodFactoryConfig): T & unknown[];
 };
 ```
 
+Parses a value into a JsonArray, throwing if it does not conform.
+
 ## Call Signature
 
 ```ts
-<T>(value): T & unknown[] | undefined;
+<T>(value: T): T & unknown[] | undefined;
 ```
 
 ### Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -2009,24 +1876,21 @@ const toJsonArray: {
 ## Call Signature
 
 ```ts
-<T>(value, assert): T & unknown[];
+<T>(value: T, assert: ZodFactoryConfig): T & unknown[];
 ```
 
 ### Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
-
-### assert
-
-`ZodFactoryConfig`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
+| `assert` | `ZodFactoryConfig` |
 
 ### Returns
 
@@ -2040,28 +1904,30 @@ const toJsonArray: {
 
 ```ts
 const toJsonObject: {
-<T>  (value): T & Record<string, unknown> | undefined;
-<T>  (value, assert): T & Record<string, unknown>;
+<T>  (value: T): T & Record<string, unknown> | undefined;
+<T>  (value: T, assert: ZodFactoryConfig): T & Record<string, unknown>;
 };
 ```
 
+Parses a value into a JsonObject, throwing if it does not conform.
+
 ## Call Signature
 
 ```ts
-<T>(value): T & Record<string, unknown> | undefined;
+<T>(value: T): T & Record<string, unknown> | undefined;
 ```
 
 ### Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -2070,24 +1936,21 @@ const toJsonObject: {
 ## Call Signature
 
 ```ts
-<T>(value, assert): T & Record<string, unknown>;
+<T>(value: T, assert: ZodFactoryConfig): T & Record<string, unknown>;
 ```
 
 ### Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
-
-### assert
-
-`ZodFactoryConfig`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
+| `assert` | `ZodFactoryConfig` |
 
 ### Returns
 
@@ -2101,28 +1964,30 @@ const toJsonObject: {
 
 ```ts
 const toJsonValue: {
-<T>  (value): T | undefined;
-<T>  (value, assert): T;
+<T>  (value: T): T | undefined;
+<T>  (value: T, assert: ZodFactoryConfig): T;
 };
 ```
 
+Parses a value into a JsonValue, throwing if it does not conform.
+
 ## Call Signature
 
 ```ts
-<T>(value): T | undefined;
+<T>(value: T): T | undefined;
 ```
 
 ### Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -2131,24 +1996,21 @@ const toJsonValue: {
 ## Call Signature
 
 ```ts
-<T>(value, assert): T;
+<T>(value: T, assert: ZodFactoryConfig): T;
 ```
 
 ### Type Parameters
 
-### T
-
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
-
-### assert
-
-`ZodFactoryConfig`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
+| `assert` | `ZodFactoryConfig` |
 
 ### Returns