cidr-tools

Tools to work with IPv4 and IPv6 CIDR network lists

Usage no npm install needed!

<script type="module">
  import cidrTools from 'https://cdn.skypack.dev/cidr-tools';
</script>

README

cidr-tools

Tools to work with IPv4 and IPv6 CIDR network lists

Install

$ npm i cidr-tools

Example

const cidrTools = require('cidr-tools');

cidrTools.merge(['1.0.0.0/24', '1.0.1.0/24']); //=> ['1.0.0.0/23']
cidrTools.exclude(['::1/127'], ['::1/128']) //=> ['::/128']
cidrTools.expand(['2001:db8::/126']) //=> ['2001:db8::', '2001:db8::1', '2001:db8::2', '2001:db8::3']
cidrTools.overlap('1.0.0.0/24', '1.0.0.128/25') //=> true
cidrTools.normalize('0:0:0:0:0:0:0:0/0') //=> '::/0'

API

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.

cidrTools.merge(networks)

  • networks String or Array: One or more CIDR or IP addresses.

Returns an array of merged networks.

cidrTools.exclude(baseNetworks, excludeNetworks)

  • baseNetworks String or Array: One or more CIDR or IP addresses.
  • excludeNetworks String or Array: One or more CIDR or IP addresses to exclude from baseNetworks.

Returns an array of merged remaining networks.

cidrTools.expand(networks)

  • networks String or Array: One or more CIDR or IP addresses.

Returns an array of individual IPs contained in the networks.

cidrTools.overlap(networksA, 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 if networksA overlap (intersect) with networksB.

cidrTools.normalize(network)

  • network String: A CIDR or IP address.

Returns a string with a normalized representation of a IP or CIDR. Will not include a prefix on single IPs.

© silverwind, distributed under BSD licence.