cidr-tools - npm Package Compare versions

Comparing version 11.0.1 to 11.0.2

dist/index.d.ts

@@ -21,8 +21,14 @@ type IPv4Address = string;
 };
+/** Returns a string or array (depending on input) with a normalized representation. Will not include a prefix on single IPs. Will set network address to the start of the network. */
 export declare function normalizeCidr<T extends Network | Network[]>(cidr: T, opts?: NormalizeOpts): T;
+/** Returns a `parsed` Object which is used internally by this module. It can be used to test whether the passed network is IPv4 or IPv6 or to work with the BigInts directly. */
 export declare function parseCidr(str: Network): ParsedCidr;
+/** Returns an array of merged networks */
 export declare function mergeCidr(nets: Networks): Network[];
+/** Returns an array of merged remaining networks of the subtraction of `excludeNetworks` from `baseNetworks`. */
 export declare function excludeCidr(base: Networks, excl: Networks): Network[];
 export declare function expandCidr(nets: Networks): Generator<Network>;
+/** Returns a boolean that indicates if `networksA` overlap (intersect) with `networksB`. */
 export declare function overlapCidr(a: Networks, b: Networks): boolean;
+/** Returns a boolean that indicates whether `networksA` fully contain all `networksB`. */
 export declare function containsCidr(a: Networks, b: Networks): boolean;
@@ -29,0 +35,0 @@ declare const _default: {

package.json

 {
   "name": "cidr-tools",
-  "version": "11.0.1",
+  "version": "11.0.2",
   "author": "silverwind <[e-mail]>",
@@ -24,4 +24,4 @@ "description": "Tools to work with IPv4 and IPv6 CIDR",
     "eslint": "8.57.0",
-    "eslint-config-silverwind": "91.0.2",
-    "eslint-config-silverwind-typescript": "8.0.4",
+    "eslint-config-silverwind": "91.0.6",
+    "eslint-config-silverwind-typescript": "8.0.6",
     "typescript-config-silverwind": "6.0.0",
@@ -28,0 +28,0 @@ "updates": "16.4.0",

README.md

@@ -51,3 +51,3 @@ # cidr-tools
 
-Returns an array of merged remaining networks.
+Returns an array of merged remaining networks of the subtraction of `excludeNetworks` from `baseNetworks`.
 
@@ -54,0 +54,0 @@ ### expandCidr(networks)

No alert changes

Improved metrics

Total package byte prevSize

18436

increased by4.77%

Lines of code

334

increased by1.83%

No dependency changes