ip-address

What is ip-address?

The ip-address npm package provides utilities for handling, validating, and manipulating IPv4 and IPv6 addresses in JavaScript. It's useful for applications that need to work with IP addresses, whether it's for networking, security, or data analysis purposes.

What are ip-address's main functionalities?

Parsing and validating IP addresses

This feature allows you to parse and validate IPv4 and IPv6 addresses. The example demonstrates how to create IPv4 and IPv6 objects from string representations of the addresses.

const {IPv4, IPv6} = require('ip-address');
let ipv4 = new IPv4('192.168.0.1');
let ipv6 = new IPv6('2001:0db8:85a3:0000:0000:8a2e:0370:7334');

Checking if an IP address is in a subnet

This feature enables checking if an IP address belongs to a specific subnet. The code sample checks if the '192.168.1.1' address is within the '192.168.1.0/24' subnet.

const {IPv4} = require('ip-address');
let ipv4 = new IPv4('192.168.1.1');
console.log(ipv4.isInSubnet(new IPv4('192.168.1.0/24')));

Converting IP addresses to binary representation

This feature allows converting IP addresses to their binary representation. The example converts the IPv4 address '192.168.1.1' to its binary form.

const {IPv4} = require('ip-address');
let ipv4 = new IPv4('192.168.1.1');
console.log(ipv4.binaryZeroPad());

Other packages similar to ip-address

ip

The 'ip' package provides basic utilities for IP address manipulation, including subnet calculations and IP version checking. It's simpler and has fewer features compared to 'ip-address', which offers more comprehensive IPv6 support and address parsing capabilities.

cidr-js

The 'cidr-js' package is focused on CIDR (Classless Inter-Domain Routing) block calculations, such as checking if an IP address is within a CIDR block. While it overlaps with some functionalities of 'ip-address', it doesn't provide as extensive support for individual IP address manipulations or validations.

README

ip-address

ip-address is a library for manipulating IPv6 and IPv4 addresses in JavaScript.

Pardon our dust

I'm currently working on tearing out the browser-specific stuff because I don't want to duplicate the work of browserify. You should be able to use it just fine with browserify right now but I'd like to do more cleanup before pushing 4.0 to npm.

I'll also be doing some renaming but will keep around the old names with deprecation warnings.

Examples

For node:

var v6 = require('ip-address').v6;

var address = new v6.Address('2001:0:ce49:7601:e866:efff:62c3:fffe');

console.log(address.isValid()); // Prints "true"

var teredo = address.teredo();

console.log(teredo.client4);    // Prints "157.60.0.1"

Current functionality

• Parsing of most IPv6 notations
• Parsing of IPv6 Addresses and Ports from URLs with v6.Address.fromURL(url)
• Validity checking
• Decoding of the Teredo information in an address
• Whether one address is a valid subnet of another
• What special properties a given address has (multicast prefix, unique local address prefix, etc.)
• Number of subnets of a certain size in a given address
• Display methods
  • Hex, binary, and decimal
  • Canonical form
  • Correct form
  • IPv4-compatible (i.e. ::ffff:192.168.0.1)
• Works in node.js and the browser
• Unit tests with node.js and Mocha

Used by

• anon which powers @congressedits, among many others
• node-swiz which is used by Rackspace
• node-socksified

Future functionality

• Investigate procstreams for the CLI tool
• Base 64/85 encoding?
• Reverse lookups? (Whether a domain name has IPv6 glue)

TODO

• Documentation
• npm deprecate, rename to ip-address