Atlas

Appearance

Variable: IpAddress ​

IpAddress: Constructor<IpAddress>

Defined in: types.ts:46

Constructor for IpAddress branded type with validation.

Param ​

The IP address string to validate

Returns ​

A validated IpAddress branded value

Throws ​

Brand error if string is not a valid IPv4 or IPv6 address

Example ​

typescript
const ipv4 = IpAddress('192.168.1.1');  // Valid IPv4
const ipv6 = IpAddress('::1');          // Valid IPv6
IpAddress('invalid');                   // Throws: Invalid IP address
IpAddress('256.1.1.1');                 // Throws: Invalid IP address