cidr-regex 4.0.3 → 4.0.5

package/README.md

@@ -1,5 +1,5 @@
 # cidr-regex
-[![](https://img.shields.io/npm/v/cidr-regex.svg?style=flat)](https://www.npmjs.org/package/cidr-regex) [![](https://img.shields.io/npm/dm/cidr-regex.svg)](https://www.npmjs.org/package/cidr-regex)
+[![](https://img.shields.io/npm/v/cidr-regex.svg?style=flat)](https://www.npmjs.org/package/cidr-regex) [![](https://img.shields.io/npm/dm/cidr-regex.svg)](https://www.npmjs.org/package/cidr-regex) [![](https://packagephobia.com/badge?p=cidr-regex)](https://packagephobia.com/result?p=cidr-regex)
 
 > Regular expression for matching IP addresses in CIDR notation
 
@@ -50,9 +50,10 @@ Only match an exact string. Useful with `RegExp#test()` to check if a string is
 
 ## Related
 
+- [ip-bigint](https://github.com/silverwind/ip-bigint) - Convert IPv4 and IPv6 addresses to native BigInt and vice-versa
+- [ip-regex](https://github.com/sindresorhus/ip-regex) - Regular expression for matching IP addresses
 - [is-cidr](https://github.com/silverwind/is-cidr) - Check if a string is an IP address in CIDR notation
 - [is-ip](https://github.com/sindresorhus/is-ip) - Check if a string is an IP address
-- [ip-regex](https://github.com/sindresorhus/ip-regex) - Regular expression for matching IP addresses
 - [cidr-tools](https://github.com/silverwind/cidr-tools) - Tools to work with IPv4 and IPv6 CIDR network lists
 
 ## License

package/index.d.ts

@@ -1,24 +1,31 @@
-declare namespace ip {
-  interface Options {
-    /**
-    Only match an exact string. Useful with `RegExp#test()` to check if a string is a CIDR IP address. *(`false` matches any CIDR IP address in a string)*
-
-    @default false
-    */
-    readonly exact?: boolean;
-  }
+export type Options = {
+  /**
+  Only match an exact string. Useful with `RegExp#test()` to check if a string is an IP address. *(`false` matches any IP address in a string)*
+
+  @default false
+  */
+  readonly exact?: boolean;
 }
 
-declare const ip: {
+/**
+@returns A regex for matching IPv4 CIDRs.
+*/
+export function v4(options?: Options): RegExp;
+
+/**
+@returns A regex for matching IPv6 CIDRs.
+*/
+export function v6(options?: Options): RegExp;
+
+declare const _default: {
+
   /**
-  Regular expression for matching IP addresses in CIDR notation.
+  Regular expression for matching IP addresses in CIDR notation
 
-  @returns A regex for matching both IPv4 and IPv6 CIDR IP addresses.
+  @returns A regex for matching both IPv4 and IPv6 CIDRs.
 
   @example
   ```
-  import cidrRegex = require("cidr-regex");
-
   // Contains a CIDR IP address?
   cidrRegex().test("foo 192.168.0.1/24");
   //=> true
@@ -27,29 +34,16 @@ declare const ip: {
   cidrRegex({exact: true}).test("foo 192.168.0.1/24");
   //=> false
 
-  "foo 192.168.0.1/24 bar 1:2:3:4:5:6:7:8/64 baz".match(cidrRegex());
-  //=> ["192.168.0.1/24", "1:2:3:4:5:6:7:8/64"]
-  ```
-  */
-  (options?: ip.Options): RegExp;
-
-  /**
-  @returns A regex for matching IPv4 CIDR IP addresses.
-  */
-  v4(options?: ip.Options): RegExp;
-
-  /**
-  @returns A regex for matching IPv6 CIDR IP addresses.
-
-  @example
-  ```
-  import cidrRegex = require("cidr-regex");
-
   cidrRegex.v6({exact: true}).test("1:2:3:4:5:6:7:8/64");
   //=> true
+
+  // Extract CIDRs from string
+  "foo 192.168.0.1/24 bar 1:2:3:4:5:6:7:8/64 baz".match(cidrRegex());
+  //=> ["192.168.0.1/24", "1:2:3:4:5:6:7:8/64"]
   ```
   */
-  v6(options?: ip.Options): RegExp;
+  (options?: Options): RegExp,
+  v4: typeof v4;
+  v6: typeof v6;
 };
-
-export = ip;
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cidr-regex",
-  "version": "4.0.3",
+  "version": "4.0.5",
   "description": "Regular expression for matching IP addresses in CIDR notation",
   "author": "silverwind <me@silverwind.io>",
   "contributors": [
@@ -22,11 +22,12 @@
     "ip-regex": "^5.0.0"
   },
   "devDependencies": {
-    "eslint": "8.37.0",
-    "eslint-config-silverwind": "65.1.3",
-    "tsd": "0.28.1",
-    "updates": "13.2.9",
-    "versions": "10.4.2",
-    "vitest": "0.29.8"
+    "eslint": "8.57.0",
+    "eslint-config-silverwind": "83.0.1",
+    "tsd": "0.31.0",
+    "updates": "16.0.0",
+    "versions": "12.0.1",
+    "vitest": "1.4.0",
+    "vitest-config-silverwind": "7.0.3"
   }
 }