ip-utilties 1.1.1 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ip-utilties",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -16,7 +16,8 @@
     "ipv4",
     "ipv6",
     "network",
-    "subnet"
+    "subnet",
+    "cidr"
   ],
   "contributors": [
     {

package/src/ip.mjs

@@ -1,4 +1,5 @@
 const ipv4 = {
+  name: "IPv4",
   factory: Uint8Array,
   normalize(address) {
     return address;
@@ -12,6 +13,7 @@ const ipv4 = {
 };
 
 const ipv6 = {
+  name: "IPv6",
   factory: Uint16Array,
   normalize(address) {
     const parts = address.split(":");
@@ -49,9 +51,7 @@ function _encode(family, address) {
       const res = new family.factory(family.segments);
 
       let i = 0;
-      for (const segment of family
-        .normalize(address)
-        .split(family.separator)) {
+      for (const segment of family.normalize(address).split(family.separator)) {
         res[i++] = parseInt(segment, family.base);
       }
 
@@ -140,6 +140,15 @@ export function isIPv6(address) {
   return _is(ipv6, address);
 }
 
+/**
+ * IP address family for a given address.
+ * @param {string|Uint8Array|Uint16Array} address
+ * @return {string|undefined}
+ */
+export function familyIP(address) {
+  return _family(address)?.name;
+}
+
 function _family(address) {
   return [ipv4, ipv6].find(d => _is(d, address));
 }
@@ -151,8 +160,7 @@ function _is(family, address) {
 
     case "object":
       return (
-        address instanceof family.factory &&
-        address.length === family.segments
+        address instanceof family.factory && address.length === family.segments
       );
   }
 
@@ -192,8 +200,7 @@ export function prefixIP(address, length) {
 
 function _prefix(family, address, length) {
   return (
-    _asBigInt(family, address) &
-    (-1n << BigInt(family.bitLength - length))
+    _asBigInt(family, address) & (-1n << BigInt(family.bitLength - length))
   );
 }
 
@@ -207,6 +214,11 @@ export function rangeIP(address, prefix, lowerAdd = 0, upperReduce = 0) {
   ];
 }
 
+export function matchPrefixIP(prefix, length, address) {
+  const family = _family(address);
+  return _prefix(family, address, length) === _prefix(family, prefix, length);
+}
+
 export function normalizeCIDR(address) {
   let [prefix, prefixLength] = address.split(/\//);
   let longPrefix;

package/types/ip.d.mts

@@ -6,9 +6,16 @@ export function decodeIPv4(address: any, length: any): string;
 export function decodeIP(address: any, length: any): string;
 export function isIPv4(address: any): boolean;
 export function isIPv6(address: any): boolean;
+/**
+ * IP address family for a given address.
+ * @param {string|Uint8Array|Uint16Array} address
+ * @return {string|undefined}
+ */
+export function familyIP(address: string | Uint8Array | Uint16Array): string | undefined;
 export function asBigInt(address: any): any;
 export function prefixIP(address: any, length: any): string;
 export function rangeIP(address: any, prefix: any, lowerAdd?: number, upperReduce?: number): any[];
+export function matchPrefixIP(prefix: any, length: any, address: any): boolean;
 export function normalizeCIDR(address: any): {
     longPrefix?: undefined;
     prefix?: undefined;