ip

Creates an IP address validation action.

This validation action accepts IPv4 and IPv6 addresses. For a more specific validation, you can also use ipv4 or ipv6.

const Action = v.ip<TInput, TMessage>(message);

Generics

Parameters

  • message TMessage

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

Examples

The following examples show how ip can be used.

IP address schema

Schema to validate an IP address.

const IpAddressSchema = v.pipe(
  v.string(),
  v.ip('The IP address is badly formatted.')
);

The following APIs can be combined with ip.

Schemas

Methods

Utils

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of Thanaen
  • GitHub profile picture of osdiab
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of F0rce
  • GitHub profile picture of fabulousgk
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of andrew-d-jackson
  • GitHub profile picture of dslatkin