ip-bigint

ip-bigint

Convert IPv4 and IPv6 addresses to native BigInt and vice-versa

Usage

import {parseIp, stringifyIp, normalizeIp} from "ip-bigint";

parseIp("2001:db8::");
// => {number: 42540766411282592856903984951653826560n, version: 6}

stringifyIp({number, version});
// => "2001:db8::"

normalizeIp("2001:db8::0:0:1")
// => "2001:db8::1"

API

parseIp(ip)

Parse a IP address string to a object (with null prototype).

For IPv4 returns {number, version}. For IPv6 returns {number, version, [ipv4mapped], [scopeid]}.

There is only rudimentary validation that the passed string is actually an IP address. You are encouraged to validate yourself using modules like ip-regex.

stringifyIp({number, version, [ipv4mapped], [scopeid]}, [opts])

Convert a parsed object to IP adress string.

opts: Options Object

• compress: Whether to compress the IP. For IPv6, this means the "best representation" all-lowercase shortest possible form. Default: true.

normalizeIp(ip, [opts])

Round-trip an IP address through parseIp and stringifyIp, effectively normalizing its representation.

opts: Options Object

• compress: Whether to compress the IP. For IPv6, this means the "best representation" all-lowercase shortest possible form. Default: true.

max4

A BigInt value that holds the biggest possible IPv4 address.

max6

A BigInt value that holds the biggest possible IPv6 address.

License

© silverwind, distributed under BSD licence