ip-bigint

ip-bigint

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

Install

npm i ip-bigint

Example

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

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

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]})

Convert a object to string. Returns ip. For IPv6, ip is normalized to the "best representation" all-lowercase shortest possible form.

Constants

The module exports max4 and max6 properties which represent the biggest possible BigInt for IPv4 and IPv6 respectively.

License

© silverwind, distributed under BSD licence