minProps

Creates a min properties validation action.

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

Generics

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

Parameters

• requirement TRequirement
• message TMessage

Explanation

With minProps 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 MinPropsAction<TInput, TRequirement, TMessage>

Examples

The following examples show how minProps can be used.

Minimum object properties

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

const MinPropsSchema = v.pipe(
  v.record(v.string(), v.number()),
  v.minProps(5, 'The object should have at least 3 properties.')
);

Related

The following APIs can be combined with minProps.

Schemas

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

Methods

• pipe

Utils

• isOfKind,
• isOfType