entries

Creates an entries validation action.

const Action = v.entries<TInput, TRequirement, TMessage>(requirement, message);

Generics

• TInput extends EntriesInput
• TRequirement extends number
• TMessage extends ErrorMessage<EntriesIssue<TInput, TRequirement>> | undefined

Parameters

• requirement TRequirement
• message TMessage

Explanation

With entries you can validate the number of entries of an object. If the input does not match the requirement, you can use message to customize the error message.

Returns

• Action EntriesAction<TInput, TRequirement, TMessage>

Examples

The following examples show how entries can be used.

Exact object entries

Schema to validate an object that does have 5 entries.

const EntriesSchema = v.pipe(
  v.record(v.string(), v.number()),
  v.entries(5, 'Object must have 5 entries')
);

Related

The following APIs can be combined with entries.

Schemas

• looseObject,
• object,
• objectWithRest,
• record,
• strictObject,
• variant

Methods

• pipe

Utils

• isOfKind,
• isOfType