silverwind

ip-bigint

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

const isIP = ip => ip.includes(":") ? 6 : ip.includes(".") ? 4 : 0;

  if (!version) throw new Error(`Invalid IP address: ${ip}`);

    for (const n of ip.split(".").map(BigInt).reverse()) {

          const digits = part.split(".").map(str => Number(str).toString(16).padStart(2, "0"));

          return `${digits[0]}${digits[1]}:${digits[2]}${digits[3]}`;

      [, ip, scopeid] = /(.+)%(.+)/.exec(ip);

    for (const n of parts.map(part => BigInt(parseInt(part || 0, 16))).reverse()) {

export function stringifyIp({number, version, ipv4mapped, scopeid} = {}) {

export function stringifyIp({number, version, ipv4mapped, scopeid} = {}, {compress = true} = {}) {

  if (typeof number !== "bigint") throw new Error(`Expected a BigInt`);

  if (![4, 6].includes(version)) throw new Error(`Invalid version: ${version}`);

  if (number < 0n || number > (version === 4 ? max4 : max6)) throw new Error(`Invalid number: ${number}`);

  const stepReduction = version === 4 ? 8n : 16n;

      for (const [index, num] of parts.entries()) {

          ip += `${String(num >> 8n)}.${String(num & 255n)}${index === 6 ? "." : ""}`;

        ip = compressIPv6(ip.split(":"));

      ip = compressIPv6(parts.map(n => n.toString(16)));

        ip = parts.map(n => n.toString(16)).join(":");

export function normalizeIp(ip, {compress = true} = {}) {

  return stringifyIp(parseIp(ip), {compress});

// take the longest or first sequence of "0" segments and replace it with "::"

  for (const [index, part] of parts.entries()) {

        currentSequence = new Set([index]);

          longestSequence = currentSequence;

        } else if (currentSequence.size > longestSequence.size) {

  if (!longestSequence && currentSequence) {

  } else if (currentSequence && currentSequence.size > longestSequence.size) {

  for (const index of longestSequence || []) {

  return parts.filter(Boolean).join(":").replace(/:{2,}/, "::");

  "description": "Convert IPv4 and IPv6 addresses to native BigInt and vice-versa",

  "author": "silverwind <me@silverwind.io>",

    "eslint-config-silverwind": "73.0.0",

[![](https://img.shields.io/npm/v/ip-bigint.svg?style=flat)](https://www.npmjs.org/package/ip-bigint) [![](https://img.shields.io/npm/dm/ip-bigint.svg)](https://www.npmjs.org/package/ip-bigint) [![](https://img.shields.io/bundlephobia/minzip/ip-bigint.svg)](https://bundlephobia.com/package/ip-bigint)

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

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

// => {number: 42540766411282592856903984951653826560n, version: 6}

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

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

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

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

Convert a parsed object to IP adress string.

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

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

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

A `BigInt` value that holds the biggest possible IPv4 address.

A `BigInt` value that holds the biggest possible IPv6 address.

		{
		"name": "ip-bigint",
		"version": "7.0.2",
		"version": "7.1.0",
		"description": "Convert IPv4 and IPv6 addresses to native BigInt and vice-versa",
		@@ -5,0 +5,0 @@ "author": "silverwind <me@silverwind.io>",

		@@ -61,3 +61,3 @@ export const max4 = 2n ** 32n - 1n;

		export function stringifyIp({number, version, ipv4mapped, scopeid} = {}) {
		export function stringifyIp({number, version, ipv4mapped, scopeid} = {}, {compress = true} = {}) {
		if (typeof number !== "bigint") throw new Error(`Expected a BigInt`);
		@@ -92,5 +92,11 @@ if (![4, 6].includes(version)) throw new Error(`Invalid version: ${version}`);
		}
		ip = compressIPv6(ip.split(":"));
		if (compress) {
		ip = compressIPv6(ip.split(":"));
		}
		} else {
		ip = compressIPv6(parts.map(n => n.toString(16)));
		if (compress) {
		ip = compressIPv6(parts.map(n => n.toString(16)));
		} else {
		ip = parts.map(n => n.toString(16)).join(":");
		}
		}
		@@ -106,4 +112,4 @@

		export function normalizeIp(ip) {
		return stringifyIp(parseIp(ip));
		export function normalizeIp(ip, {compress = true} = {}) {
		return stringifyIp(parseIp(ip), {compress});
		}
		@@ -110,0 +116,0 @@

		@@ -33,16 +33,26 @@ # ip-bigint

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

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

		### normalizeIp(ip)
		`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.

		### Constants
		`opts`: Options `Object`
		- `compress`: Whether to compress the IP. For IPv6, this means the "best representation" all-lowercase shortest possible form. Default: `true`.

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

		A `BigInt` value that holds the biggest possible IPv4 address.

		### max6

		A `BigInt` value that holds the biggest possible IPv6 address.

		## License

		© [silverwind](https://github.com/silverwind), distributed under BSD licence

Improved metrics