diff options
Diffstat (limited to 'node_modules/is-cidr/README.md')
| -rw-r--r-- | node_modules/is-cidr/README.md | 16 |
1 files changed, 6 insertions, 10 deletions
diff --git a/node_modules/is-cidr/README.md b/node_modules/is-cidr/README.md index 1fa3ee9ed..a786cd481 100644 --- a/node_modules/is-cidr/README.md +++ b/node_modules/is-cidr/README.md @@ -1,6 +1,6 @@ # is-cidr -[](https://www.npmjs.org/package/is-cidr) [](https://www.npmjs.org/package/is-cidr) [](https://travis-ci.org/silverwind/is-cidr) +[](https://www.npmjs.org/package/is-cidr) [](https://www.npmjs.org/package/is-cidr) > Check if a string is an IP address in CIDR notation @@ -10,21 +10,18 @@ npm i is-cidr ``` - ## Usage ```js -const isCidr = require('is-cidr'); +const isCidr = require("is-cidr"); -isCidr('192.168.0.1/24'); //=> 4 -isCidr('1:2:3:4:5:6:7:8/64'); //=> 6 -isCidr('10.0.0.0'); //=> 0 -isCidr.v6('10.0.0.0/24'); //=> false +isCidr("192.168.0.1/24"); //=> 4 +isCidr("1:2:3:4:5:6:7:8/64"); //=> 6 +isCidr("10.0.0.0"); //=> 0 +isCidr.v6("10.0.0.0/24"); //=> false ``` - ## API - ### isCidr(input) Check if `input` is a IPv4 or IPv6 CIDR address. Returns either `4`, `6` (indicating the IP version) or `0` if the string is not a CIDR. @@ -37,7 +34,6 @@ Check if `input` is a IPv4 CIDR address. Returns a boolean. Check if `input` is a IPv6 CIDR address. Returns a boolean. - ## Related - [cidr-regex](https://github.com/silverwind/cidr-regex) - Regular expression for matching IP addresses in CIDR notation |