Class ObjectCheck

Validates object-shaped input and coordinates checks for its fields.

Use this class when the input should be an object and individual fields need their own validation rules.

Example

const result = await ObjectCheck.for({ name: 'Ada' })
  .check(checker => [
    checker.required('name').notEmpty()
  ])
  .then(checker => checker.result({ nested: true }));

Implements

Check

Index

Constructors

constructor

new ObjectCheck(key: string | number | null | undefined, data: any): ObjectCheck
Creates an object checker for a value or for a named field within a parent object.

When both key and data are provided, the checker reads data[key].
Parameters
- key: string | number | null | undefined
- data: any
Returns ObjectCheck
- Defined in checks/object.check.ts:57

Properties

`Protected`key

key: string | number | null | undefined

`Protected`data

data: any

`Protected`has_value

has_value: boolean

`Protected`is_object

is_object: boolean

`Protected`check_extra_fields

check_extra_fields: boolean

`Protected`known_keys

known_keys: Set<string>

`Protected`out

out: ResultSet

Methods

`Static`for

for(data: any): ObjectCheck
Creates an object checker for a top-level input value.
Parameters
- data: any
Returns ObjectCheck
Example
```
const checker = ObjectCheck.for({ email: 'user@example.com' });
```
- Defined in checks/object.check.ts:48

notEmpty

notEmpty(options?: CheckOptions): this
Requires the value to exist and contain at least one key.
Parameters
- Optionaloptions: CheckOptions
Returns this
Example
```
const result = ObjectCheck.for({}).notEmpty().result();
```
- Defined in checks/object.check.ts:87

object

object(options?: CheckOptions): this
Requires the value to be a non-array object.

This check runs automatically during construction when a value is present.
Parameters
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/object.check.ts:105

required

required(name: string, options?: CheckOptions): FieldCheck
Returns a checker for a required field and marks that field as known.

Known fields are used later by noExtraFields.
Parameters
- name: string
- Optionaloptions: CheckOptions
Returns FieldCheck
Example
```
const nameCheck = ObjectCheck.for({ name: 'Ada' }).required('name');
```
- Defined in checks/object.check.ts:129

optional

optional(name: string): FieldCheck
Returns a checker for an optional field and marks that field as known.
Parameters
- name: string
Returns FieldCheck
Example
```
const nicknameCheck = ObjectCheck.for({}).optional('nickname');
```
- Defined in checks/object.check.ts:142

conditional

conditional(
    name: string,
    condition: (data: any) => boolean,
    options?: CheckOptions,
): FieldCheck
Returns a field checker that becomes required only when condition passes.

The condition receives the current object value.
Parameters
- name: string
- condition: (data: any) => boolean
- Optionaloptions: CheckOptions
Returns FieldCheck
Example
```
const checker = ObjectCheck.for({ type: 'person' });
checker.conditional('name', data => data.type === 'person').notEmpty();
```
- Defined in checks/object.check.ts:158

noExtraFields

noExtraFields(options?: CheckOptions): this
Fails when the input contains keys that were not declared through required, optional, or conditional.

The extra-field check is evaluated when result is called.
Parameters
- Optionaloptions: CheckOptions
Returns this
Example
```
const result = ObjectCheck.for({ name: 'Ada', extra: true })
  .required('name')
  .noExtraFields()
  .result();
```
- Defined in checks/object.check.ts:181

`Protected`rules

rules(field_checks: (Check | Promise<Check>)[]): Promise<ObjectCheck>
Parameters
- field_checks: (Check | Promise<Check>)[]
Returns Promise<ObjectCheck>
- Defined in checks/object.check.ts:213

check

check(
func: (checker: ObjectCheck) => (Check | Promise<Check>)[],
): Promise<ObjectCheck>
Runs a group of field or nested checks and merges their results.

Return an array of checks from the callback. Each check can be synchronous or a promise.
Parameters
- func: (checker: ObjectCheck) => (Check | Promise<Check>)[]
Returns Promise<ObjectCheck>
Example
```
const checker = await ObjectCheck.for({ name: 'Ada', age: 37 }).check(c => [
  c.required('name').notEmpty(),
  c.optional('age').number()
]);
```
- Defined in checks/object.check.ts:249

allOf

allOf(
func: (checker: ObjectCheck) => (Check | Promise<Check>)[],
): Promise<ObjectCheck>
Alias for check using JSON Schema-style naming.

All returned checks must pass for the composed result to stay valid.
Parameters
- func: (checker: ObjectCheck) => (Check | Promise<Check>)[]
Returns Promise<ObjectCheck>
- Defined in checks/object.check.ts:260

anyOf

anyOf(
branches: ((checker: ObjectCheck) => (Check | Promise<Check>)[])[],
): Promise<ObjectCheck>
Evaluates alternative branches and succeeds when at least one branch is valid.

Each branch function is evaluated in isolation using cloned object state. Valid branches are then replayed on the current checker so mutations behave the same way as normal non-branch checks.
Parameters
- branches: ((checker: ObjectCheck) => (Check | Promise<Check>)[])[]
Returns Promise<ObjectCheck>
- Defined in checks/object.check.ts:271

oneOf

oneOf(
branches: ((checker: ObjectCheck) => (Check | Promise<Check>)[])[],
): Promise<ObjectCheck>
Evaluates alternative branches and succeeds only when exactly one branch is valid.

Each branch function is evaluated in isolation using cloned object state. The single winning branch is then replayed on the current checker so mutations behave the same way as normal non-branch checks.
Parameters
- branches: ((checker: ObjectCheck) => (Check | Promise<Check>)[])[]
Returns Promise<ObjectCheck>
- Defined in checks/object.check.ts:282

not

not(
func: (checker: ObjectCheck) => (Check | Promise<Check>)[],
options?: CheckOptions,
): Promise<ObjectCheck>
Inverts a composed object branch and fails when that branch is valid.

The negated branch is evaluated in isolation and is never replayed onto the current checker, so mutations inside the branch do not affect the original input.
Parameters
- func: (checker: ObjectCheck) => (Check | Promise<Check>)[]
- Optionaloptions: CheckOptions
Returns Promise<ObjectCheck>
- Defined in checks/object.check.ts:293

matchesType

matchesType<T>(
type: new (...args: any[]) => T,
options?: ClassValidationOptions,
): Promise<ObjectCheck>
Validates the current object value against a class definition. *
- This merges the class-validation result into the current checker so it can
- be composed with fluent object rules.
Type Parameters
- T
Parameters
- type: new (...args: any[]) => T
- Optionaloptions: ClassValidationOptions
Returns Promise<ObjectCheck>
Example
- const checker = await ObjectCheck.for(payload).matchesType(PersonDto);
- Defined in checks/object.check.ts:318

isTrue

isTrue(
func: (data: any) => boolean | Promise<boolean>,
options?: CheckOptions,
): Promise<ObjectCheck>
Applies a custom predicate to the current object value.

When the predicate returns false, the result contains Custom check failed unless custom check options override the message or code.
Parameters
- func: (data: any) => boolean | Promise<boolean>
- Optionaloptions: CheckOptions
Returns Promise<ObjectCheck>
Example
```
const checker = await ObjectCheck.for({ role: 'admin' })
  .isTrue(data => data.role === 'admin');
```
- Defined in checks/object.check.ts:339

`Protected`errorMessage

errorMessage(err: string, options?: CheckOptions): void
Parameters
- err: string
- Optionaloptions: CheckOptions
Returns void
- Defined in checks/object.check.ts:353

inherit

inherit(priors: IResult): this
Merges a prior result into this checker when that prior result is invalid.

This is useful when composing validations from external sources.
Parameters
- priors: IResult
Returns this
- Defined in checks/object.check.ts:510

result

result(options?: ResultOptions): IResult
Returns the validation result for the current object.

With no options, this returns the raw internal result structure. With options, the output is formatted through the package result helpers.
Parameters
- Optionaloptions: ResultOptions
Returns IResult
Example
```
const result = await ObjectCheck.for({ name: 'Ada' })
  .check(c => [c.required('name').notEmpty()])
  .then(c => c.result({ nested: true }));
```
Implementation of Check.result
- Defined in checks/object.check.ts:530

Class ObjectCheck

Example

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ObjectCheck

Properties

Protectedkey

Protecteddata

Protectedhas_value

Protectedis_object

Protectedcheck_extra_fields

Protectedknown_keys

Protectedout

Methods

Staticfor

Parameters

Returns ObjectCheck

Example

notEmpty

Parameters

Returns this

Example

object

Parameters

Returns this

required

Parameters

Returns FieldCheck

Example

optional

Parameters

Returns FieldCheck

Example

conditional

Parameters

Returns FieldCheck

Example

noExtraFields

Parameters

Returns this

Example

Protectedrules

Parameters

Returns Promise<ObjectCheck>

check

Parameters

Returns Promise<ObjectCheck>

Example

allOf

Parameters

Returns Promise<ObjectCheck>

anyOf

Parameters

Returns Promise<ObjectCheck>

oneOf

Parameters

Returns Promise<ObjectCheck>

not

Parameters

Returns Promise<ObjectCheck>

matchesType

Type Parameters

Parameters

Returns Promise<ObjectCheck>

Example

isTrue

Parameters

Returns Promise<ObjectCheck>

Example

ProtectederrorMessage

Parameters

Returns void

inherit

Parameters

`Protected`key

`Protected`data

`Protected`has_value

`Protected`is_object

`Protected`check_extra_fields

`Protected`known_keys

`Protected`out

`Static`for

`Protected`rules

`Protected`errorMessage