@@ -6,39 +6,42 @@ The Netmask class parses and understands IPv4 CIDR blocks so they can be explore
66Synopsis
77--------
88
9- var Netmask = require('netmask').Netmask
9+ ``` js
10+ var Netmask = require (' netmask' ).Netmask
1011
11- var block = new Netmask('10.0.0.0/12');
12- block.base; // 10.0.0.0
13- block.mask; // 255.240.0.0
14- block.bitmask; // 12
15- block.hostmask; // 0.15.255.255
16- block.broadcast; // 10.15.255.255
17- block.size; // 1048576
18- block.first; // 10.0.0.1
19- block.last; // 10.15.255.254
12+ var block = new Netmask (' 10.0.0.0/12' );
13+ block .base ; // 10.0.0.0
14+ block .mask ; // 255.240.0.0
15+ block .bitmask ; // 12
16+ block .hostmask ; // 0.15.255.255
17+ block .broadcast ; // 10.15.255.255
18+ block .size ; // 1048576
19+ block .first ; // 10.0.0.1
20+ block .last ; // 10.15.255.254
2021
21- block.contains('10.0.8.10'); // true
22- block.contains('10.8.0.10'); // true
23- block.contains('192.168.1.20'); // false
22+ block .contains (' 10.0.8.10' ); // true
23+ block .contains (' 10.8.0.10' ); // true
24+ block .contains (' 192.168.1.20' ); // false
2425
25- block.forEach(function(ip, long, index));
26+ block .forEach (function (ip , long , index ));
2627
27- block.next() // Netmask('10.16.0.0/12')
28+ block.next() // Netmask('10.16.0.0/12')
29+ ```
2830
2931Constructing
3032------------
3133
3234Netmask objects are created with an IP address and optionally a mask. There are many forms that are recognized:
3335
34- '216.240.32.0/24' // The preferred form.
35- '216.240.32.0/255.255.255.0'
36- '216.240.32.0', '255.255.255.0'
37- '216.240.32.0', 0xffffff00
38- '216.240.32.4' // A /32 block.
39- '0330.0360.040.04' // Octal form
40- '0xd8.0xf0.0x20.0x4' // Hex form
41-
36+ ```
37+ '216.240.32.0/24' // The preferred form.
38+ '216.240.32.0/255.255.255.0'
39+ '216.240.32.0', '255.255.255.0'
40+ '216.240.32.0', 0xffffff00
41+ '216.240.32.4' // A /32 block.
42+ '0330.0360.040.04' // Octal form
43+ '0xd8.0xf0.0x20.0x4' // Hex form
44+ ```
4245
4346API
4447---
0 commit comments