maxProps

Creates a max properties validation action.

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

Generics

• TInput extends Record<string, unknown>
• TRequirement extends number
• TMessage extends ErrorMessage<MaxPropsIssue<TInput, TRequirement>> | undefined

Parameters

• requirement TRequirement
• message TMessage

Explanation

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

Returns

• Action MaxPropsAction<TInput, TRequirement, TMessage>

Examples

The following examples show how maxProps can be used.

Maximum object properties

Schema to validate an object with a maximum of 5 properties.

const MaxPropsSchema = v.pipe(
  v.record(v.string(), v.number()),
  v.maxProps(5, 'Object must not exceed 5 properties.')
);

Related

The following APIs can be combined with maxProps.

Schemas

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

Methods

• pipe

Utils

• isOfKind,
• isOfType