JSPM

  • Created
  • Published
  • Downloads 21045721
  • Score
    100M100P100Q222302F
  • License MIT

A library for parsing IPv6 and IPv4 IP addresses in node and the browser.

Package Exports

  • ip-address

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ip-address) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Build Status Coverage Status

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

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