Skip to main content

Variable: default

const default: object

The module's default export: the ipaddr.js object, exposing the parsing/validation helpers and the IPv4 / IPv6 classes.

Type Declaration​

IPv4​

readonly IPv4: typeof IPv4

IPv6​

readonly IPv6: typeof IPv6

fromByteArray()​

fromByteArray(bytes): IPv4 | IPv6

Build an address from a byte array (4 bytes for IPv4, 16 for IPv6).

Parameters​

bytes​

number[]

Returns​

IPv4 | IPv6

isValid()​

isValid(addr): boolean

Returns true if the string is a valid IPv4 or IPv6 address.

Parameters​

addr​

string

Returns​

boolean

parse()​

parse(addr): IPv4 | IPv6

Parse an IPv4 or IPv6 address, throwing on invalid input.

Parameters​

addr​

string

Returns​

IPv4 | IPv6

parseCIDR()​

parseCIDR(mask): [IPv4 | IPv6, number]

Parse an address in CIDR notation, returning [address, prefixLength].

Parameters​

mask​

string

Returns​

[IPv4 | IPv6, number]

process()​

process(addr): IPv4 | IPv6

Parse an address, converting IPv4-mapped IPv6 addresses to IPv4.

Parameters​

addr​

string

Returns​

IPv4 | IPv6

subnetMatch()​

subnetMatch(addr, rangeList, defaultName?): string

Match an address against a list of named ranges.

Parameters​

addr​

IPv4 | IPv6

rangeList​

RangeList<IPv4 | IPv6>

defaultName?​

string

Returns​

string