A JS library for manipulating IP addresses, prefixes and ranges. Supports both IPv4 and IPv6. Uses JSBI BigInt to handle IPv6 operations, to retain numeric resolution beyond the 53-bit max safe integer in JavaScript.

import { Addr, Prefix, Range } from 'ip.js';

or

const Ip = require('ip.js');

or even

<script src="//unpkg.com/ip.js"></script>

const myIp = new Ip.Addr('10.0.0.42');
myIp.version(); // 4
myIp.toNum(); // 167772160

const myPrefix = new Ip.Prefix('10.0.0.0/24');
myPrefix.countIps(); // 256
myPrefix.slice(26); // [10.0.0.0/26, 10.0.0.64/26, 10.0.0.128/26, 10.0.0.192/26]

const myV6Prefix = new Ip.Prefix('2002:DEAD::/48');
myV6Prefix.isIpV4(); // false
myV6Prefix.firstIp(); // 2002:dead::
myV6Prefix.lastIp(); // 2002:dead::ffff:ffff:ffff:ffff:ffff

const myRange = new Ip.Range('10.0.0.0', '10.0.0.42');
myRange.countIps(); // 43
myRange.toEncompassingPrefix(); // 10.0.0.0/26
myRange.toPrefixes(); // [10.0.0.0/27, 10.0.0.32/29, 10.0.0.40/31, 10.0.0.42/32]

Class to manipulate single IP addresses.

new Addr(ip, [isV4])

Creates a new object representing an IP address, based on the input ip argument. ip can be either a string (f.e. 10.0.0.0 or 2002:DEAD::), a number (167772160), a BigInt, or another instance of Addr. The optional argument isV4 defines the address family (IPv4 (true) or IPv6 (false)). If it is undefined, the address family is automatically derived from the input ip by either looking for specific family syntax in the string, or checking for numbers larger than 32 bit.

Class to manipulate IP prefixes, with the format <IP address>/<cidr>.

new Prefix(prefix)

or

new Prefix(ip, cidr, [isV4])

Creates a new object representing an IP prefix, based on the input prefix or (ip, cidr) arguments. prefix should be a string representation (f.e. 10.0.0.0/24 or 2002:DEAD::/48). The class can also be instantiated by passing a pair of ip, cidr arguments. ip supports any format understood by the Addr class, and cidr should be a number (IPv4: 0-32, IPv6: 0-128). The optional argument isV4 defines the address family (IPv4 (true) or IPv6 (false)). If it is undefined, the address family is automatically derived from the input prefix.

Class to manipulate IP ranges, with the format <first IP> - <last IP>.

new Range(firstIp, lastIp, [isV4])

Creates a new object representing an IP address range, based on the input firstIp and lastIp arguments. Both IPs are required and support any format understood by the Addr class. The optional argument isV4 defines the address family (IPv4 (true) or IPv6 (false)). If it is undefined, the address family is automatically derived from the input IP addresses. If the two IP addresses are of different address families an exception is thrown.