IP

IP address utilities for node.js

Installation

npm

1npm install ip

git

1git clone https://github.com/indutny/node-ip.git

Usage

Get your ip address, compare ip addresses, validate ip addresses, etc.

1var ip = require('ip');
2
3ip.address() // my ip address
4ip.isEqual('::1', '::0:1'); // true
5ip.toBuffer('127.0.0.1') // Buffer([127, 0, 0, 1])
6ip.toString(new Buffer([127, 0, 0, 1])) // 127.0.0.1
7ip.fromPrefixLen(24) // 255.255.255.0
8ip.mask('192.168.1.134', '255.255.255.0') // 192.168.1.0
9ip.cidr('192.168.1.134/26') // 192.168.1.128
10ip.not('255.255.255.0') // 0.0.0.255
11ip.or('192.168.1.134', '0.0.0.255') // 192.168.1.255
12ip.isPrivate('127.0.0.1') // true
13ip.isV4Format('127.0.0.1'); // true
14ip.isV6Format('::ffff:127.0.0.1'); // true
15
16// operate on buffers in-place
17var buf = new Buffer(128);
18var offset = 64;
19ip.toBuffer('127.0.0.1', buf, offset);  // [127, 0, 0, 1] at offset 64
20ip.toString(buf, offset, 4);            // '127.0.0.1'
21
22// subnet information
23ip.subnet('192.168.1.134', '255.255.255.192')
24// { networkAddress: '192.168.1.128',
25//   firstAddress: '192.168.1.129',
26//   lastAddress: '192.168.1.190',
27//   broadcastAddress: '192.168.1.191',
28//   subnetMask: '255.255.255.192',
29//   subnetMaskLength: 26,
30//   numHosts: 62,
31//   length: 64,
32//   contains: function(addr){...} }
33ip.cidrSubnet('192.168.1.134/26')
34// Same as previous.
35
36// range checking
37ip.cidrSubnet('192.168.1.134/26').contains('192.168.1.190') // true
38
39
40// ipv4 long conversion
41ip.toLong('127.0.0.1'); // 2130706433
42ip.fromLong(2130706433); // '127.0.0.1'

License

This software is licensed under the MIT License.

Copyright Fedor Indutny, 2012.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.