cidr-tools 10.1.1 → 11.0.0

package/README.md

@@ -7,13 +7,26 @@
 ```js
 import {mergeCidr, excludeCidr, expandCidr, overlapCidr, containsCidr, normalizeCidr, parseCidr} from "cidr-tools";
 
-mergeCidr(["1.0.0.0/24", "1.0.1.0/24"]); //=> ["1.0.0.0/23"]
-excludeCidr(["::1/127"], "::1/128") //=> ["::/128"]
-expandCidr(["2001:db8::/126"]) //=> ["2001:db8::", "2001:db8::1", "2001:db8::2", "2001:db8::3"]
-overlapCidr("1.0.0.0/24", "1.0.0.128/25") //=> true
-containsCidr(["1.0.0.0/24", "2.0.0.0/24"], "1.0.0.1") //=> true
-normalizeCidr("::ffff/64") //=> "::/64"
-parseCidr("::/64"); // => {cidr: "::/64", version: 6, prefix: "64", start: 0n, end: 18446744073709551615n}
+mergeCidr(["1.0.0.0/24", "1.0.1.0/24"]);
+//=> ["1.0.0.0/23"]
+
+excludeCidr(["::1/127"], "::1/128");
+//=> ["::/128"]
+
+Array.from(expandCidr(["2001:db8::/126"]));
+//=> ["2001:db8::", "2001:db8::1", "2001:db8::2", "2001:db8::3"]
+
+overlapCidr("1.0.0.0/24", "1.0.0.128/25");
+//=> true
+
+containsCidr(["1.0.0.0/24", "2.0.0.0/24"], "1.0.0.1");
+//=> true
+
+normalizeCidr("::ffff/64");
+//=> "::/64"
+
+parseCidr("::/64");
+// => {cidr: "::/64", version: 6, prefix: "64", start: 0n, end: 18446744073709551615n}
 ```
 
 ## API
@@ -41,7 +54,7 @@ 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.
+Returns a generator for individual IPs contained in the networks. Be aware that asking for expansions of big networks can result in long runtimes and possibly high memory usage. One million IPs takes about 2 seconds on modern hardware.
 
 ### overlapCidr(networksA, networksB)
 

package/dist/index.d.ts

@@ -23,7 +23,7 @@ export declare function normalizeCidr(cidr: Network[], opts?: NormalizeOpts): Ne
 export declare function parseCidr(str: Network): ParsedCidr;
 export declare function mergeCidr(nets: Networks): Network[];
 export declare function excludeCidr(base: Networks, excl: Networks): Network[];
-export declare function expandCidr(nets: Networks): Network[];
+export declare function expandCidr(nets: Networks): Generator<Network>;
 export declare function overlapCidr(a: Networks, b: Networks): boolean;
 export declare function containsCidr(a: Networks, b: Networks): boolean;
 declare const _default: {

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAIA,KAAK,WAAW,GAAG,MAAM,CAAC;AAC1B,KAAK,WAAW,GAAG,MAAM,CAAC;AAC1B,KAAK,QAAQ,GAAG,MAAM,CAAC;AACvB,KAAK,QAAQ,GAAG,MAAM,CAAC;AAEvB,KAAK,OAAO,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,CAAC;AAC/D,KAAK,QAAQ,GAAG,OAAO,GAAG,OAAO,EAAE,CAAC;AAEpC,KAAK,cAAc,GAAG,CAAC,GAAG,CAAC,CAAC;AAE5B,KAAK,UAAU,GAAG;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,cAAc,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,OAAO,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,KAAK,aAAa,GAAG;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAqCF,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC;AAC5E,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,EAAE,CAAC;AAShF,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,UAAU,CAqClD;AAkOD,wBAAgB,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,EAAE,CAWnD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,GAAG,OAAO,EAAE,CAgCrE;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,EAAE,CAWpD;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,CAqB7D;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,CAwB9D;;;;;;;;;;AAED,wBAQE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAIA,KAAK,WAAW,GAAG,MAAM,CAAC;AAC1B,KAAK,WAAW,GAAG,MAAM,CAAC;AAC1B,KAAK,QAAQ,GAAG,MAAM,CAAC;AACvB,KAAK,QAAQ,GAAG,MAAM,CAAC;AAEvB,KAAK,OAAO,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,CAAC;AAC/D,KAAK,QAAQ,GAAG,OAAO,GAAG,OAAO,EAAE,CAAC;AAEpC,KAAK,cAAc,GAAG,CAAC,GAAG,CAAC,CAAC;AAE5B,KAAK,UAAU,GAAG;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,cAAc,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,OAAO,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,KAAK,aAAa,GAAG;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAqCF,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC;AAC5E,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,EAAE,CAAC;AAShF,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,UAAU,CAqClD;AAkOD,wBAAgB,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,EAAE,CAWnD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,GAAG,OAAO,EAAE,CAgCrE;AAED,wBAAiB,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,CAS9D;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,CAqB7D;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,CAwB9D;;;;;;;;;;AAED,wBAQE"}

package/dist/index.js

@@ -234,16 +234,14 @@ function excludeCidr(base, excl) {
   }
   return bases[4].concat(bases[6]).sort(compare);
 }
-function expandCidr(nets) {
+function* expandCidr(nets) {
   const arr = uniq(Array.isArray(nets) ? nets : [nets]);
-  const ips = [];
   for (const net of mergeCidr(arr)) {
     const { start, end, version } = parseCidr(net);
     for (let number = start; number <= end; number++) {
-      ips.push(stringifyIp({ number, version }));
+      yield normalizeCidr(stringifyIp({ number, version }));
     }
   }
-  return ips.map((ip) => normalizeCidr(ip));
 }
 function overlapCidr(a, b) {
   const aNets = uniq(Array.isArray(a) ? a : [a]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cidr-tools",
-  "version": "10.1.1",
+  "version": "11.0.0",
   "author": "silverwind <me@silverwind.io>",
   "description": "Tools to work with IPv4 and IPv6 CIDR",
   "repository": "silverwind/cidr-tools",