ip

Creates a pipeline validation action that validates an IPv4 or IPv6 address.

const Validation = ip<TInput>(message);

Generics

• TInput extends string

Parameters

• message ErrorMessage | undefined

Explanation

With ip you can validate the formatting of a string. If the input is not an IP address, you can use message to customize the error message.

Returns

• Validation IpValidation<TInput>

Examples

The following examples show how ip can be used.

IP address schema

Schema to validate an IP address.

const IpAddressSchema = string([ip('The IP address is badly formatted.')]);

Related

The following APIs can be combined with ip.

Schemas

• any,
• special,
• string,
• unknown