Function anObject

An object guard factory.

Param: a

Key guard or property schema

Param: b

Value guard (key guard mode) or guard for unlisted properties (schema mode)

anObject<T extends Object<unknown>>(): Guard<T>
An object guard factory without property validation.

The returned guard checks if a value is a plain object.
Type Parameters
- T extends Object<unknown>
  The object type
Returns Guard<T>
- Defined in index.ts:394
anObject<K extends PropertyKey, V>(
key: Guarding<K>,
value: Guarding<V>,
): Guard<Record<K, V>>
An object guard factory with key and value guards.

The returned guard checks if a value is a plain object and validates each key and value using the provided guards.
Type Parameters
- K extends PropertyKey
  The key type
- V
  The value type
Parameters
- key: Guarding<K>
  Guarding for validating keys
- value: Guarding<V>
  Guarding for validating values
Returns Guard<Record<K, V>>
- Defined in index.ts:408
anObject<const T extends Object<Constant | Guarding<unknown>>>(
schema: T,
rest?: Guarding<unknown>,
): Guard<Entries<T>>
An object guard factory with schema-based property validation.

The returned guard checks if a value is a plain object and validates each property against the schema.
- If rest is omitted, the object is closed: unlisted properties are rejected
- If rest is provided, the object is open: unlisted properties are validated with the rest guard
Type Parameters
- const T extends Object<Constant | Guarding<unknown>>
  The object schema type
Parameters
- schema: T
  Schema mapping property names to guards or literal values
- Optionalrest: Guarding<unknown>
  Guard for validating unlisted properties (open object) or omit to reject them (closed object)
Returns Guard<Entries<T>>
- Defined in index.ts:423

Function anObject

Param: a

Param: b

Type Parameters

Returns Guard<T>

Type Parameters

Parameters

Returns Guard<Record<K, V>>

Type Parameters

Parameters

Returns Guard<Entries<T>>

Settings