Tools to work with IPv4 and IPv6 CIDR network lists
$ npm i cidr-tools
import {merge, exclude, expand, overlap, contains, normalize} from 'cidr-tools';
merge(['1.0.0.0/24', '1.0.1.0/24']); //=> ['1.0.0.0/23']
exclude(['::1/127'], ['::1/128']) //=> ['::/128']
expand(['2001:db8::/126']) //=> ['2001:db8::', '2001:db8::1', '2001:db8::2', '2001:db8::3']
overlap('1.0.0.0/24', '1.0.0.128/25') //=> true
contains(["1.0.0.0/24", "2.0.0.0/24"], "1.0.0.1") //=> true
normalize('::ffff/64') //=> '::/64'
All functions take CIDR addresses or single IP addresses. On single addresses, a prefix of /32
or /128
is assumed. Function that return networks will return a merged and sorted set of networks with IPv4 sorted before IPv6.
This module requires BigInt support in your environment.
networks
String or Array: One or more CIDR or IP addresses.
Returns an array of merged networks.
baseNetworks
String or Array: One or more CIDR or IP addresses.excludeNetworks
String or Array: One or more CIDR or IP addresses to exclude frombaseNetworks
.
Returns an array of merged remaining networks.
networks
String or Array: One or more CIDR or IP addresses.
Returns an array of individual IPs contained in the networks.
networksA
String or Array: One or more CIDR or IP address.networksB
String or Array: One or more CIDR or IP address.
Returns a boolean that indicates if networksA
overlap (intersect) with networksB
.
networksA
String or Array: One or more CIDR or IP address.networksB
String or Array: One or more CIDR or IP address.
Returns a boolean that indicates whether networksA
fully contain all networksB
.
networks
String or Array: One or more CIDR or IP address.
Returns a string or array (depending on input) with a normalized representation of IPs or CIDRs. Will not include a prefix on single IPs.
© silverwind, distributed under BSD licence.