cidr-regex 4.0.2 → 4.0.4

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
 
@@ -10,7 +10,7 @@ $ npm i cidr-regex
 ```
 
 ```js
-const cidrRegex = require("cidr-regex");
+import cidrRegex from "cidr-regex";
 
 // Contains a CIDR IP address?
 cidrRegex().test("foo 192.168.0.1/24");
@@ -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,55 +1,43 @@
-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;
-  }
-}
-
-declare const ip: {
+export type Options = {
   /**
-  Regular expression for matching IP addresses in CIDR notation.
-
-  @returns A regex for matching both IPv4 and IPv6 CIDR IP addresses.
+  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)*
 
-  @example
-  ```
-  import cidrRegex = require("cidr-regex");
+  @default false
+  */
+  readonly exact?: boolean;
+}
 
-  // Contains a CIDR IP address?
-  cidrRegex().test("foo 192.168.0.1/24");
-  //=> true
+/**
+@returns A regex for matching IPv4 CIDRs.
+*/
+export function v4(options?: Options): RegExp;
 
-  // Is a CIDR IP address?
-  cidrRegex({exact: true}).test("foo 192.168.0.1/24");
-  //=> false
+/**
+@returns A regex for matching IPv6 CIDRs.
+*/
+export function v6(options?: Options): RegExp;
 
-  "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;
+/**
+Regular expression for matching IP addresses in CIDR notation
 
-  /**
-  @returns A regex for matching IPv4 CIDR IP addresses.
-  */
-  v4(options?: ip.Options): RegExp;
+@returns A regex for matching both IPv4 and IPv6 CIDRs.
 
-  /**
-  @returns A regex for matching IPv6 CIDR IP addresses.
+@example
+```
+// Contains a CIDR IP address?
+cidrRegex().test("foo 192.168.0.1/24");
+//=> true
 
-  @example
-  ```
-  import cidrRegex = require("cidr-regex");
+// Is a CIDR IP address?
+cidrRegex({exact: true}).test("foo 192.168.0.1/24");
+//=> false
 
-  cidrRegex.v6({exact: true}).test("1:2:3:4:5:6:7:8/64");
-  //=> true
-  ```
-  */
-  v6(options?: ip.Options): RegExp;
-};
+cidrRegex.v6({exact: true}).test("1:2:3:4:5:6:7:8/64");
+//=> true
 
-export = ip;
+// 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"]
+```
+*/
+export default function cidrRegex(options?: Options): RegExp;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cidr-regex",
-  "version": "4.0.2",
+  "version": "4.0.4",
   "description": "Regular expression for matching IP addresses in CIDR notation",
   "author": "silverwind <me@silverwind.io>",
   "contributors": [
@@ -18,26 +18,16 @@
     "index.js",
     "index.d.ts"
   ],
-  "keywords": [
-    "cidr",
-    "regex",
-    "notation",
-    "cidr notation",
-    "prefix",
-    "prefixes",
-    "ip",
-    "ip address"
-  ],
   "dependencies": {
     "ip-regex": "^5.0.0"
   },
   "devDependencies": {
-    "eslint": "8.23.1",
-    "eslint-config-silverwind": "54.0.2",
-    "jest": "29.0.3",
-    "jest-extended": "3.1.0",
-    "tsd": "0.24.1",
-    "updates": "13.1.5",
-    "versions": "9.3.0"
+    "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"
   }
 }