summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/is-cidr/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/is-cidr/README.md')
-rw-r--r--deps/npm/node_modules/is-cidr/README.md20
1 files changed, 8 insertions, 12 deletions
diff --git a/deps/npm/node_modules/is-cidr/README.md b/deps/npm/node_modules/is-cidr/README.md
index cd7c8c9686..1fa3ee9ede 100644
--- a/deps/npm/node_modules/is-cidr/README.md
+++ b/deps/npm/node_modules/is-cidr/README.md
@@ -7,7 +7,7 @@
## Install
```
-$ npm install --save is-cidr
+npm i is-cidr
```
@@ -16,14 +16,10 @@ $ npm install --save is-cidr
```js
const isCidr = require('is-cidr');
-isCidr('192.168.0.1/24');
-//=> true
-
-isCidr('1:2:3:4:5:6:7:8/64');
-//=> true
-
-isCidr.v4('1:2:3:4:5:6:7:8/64');
-//=> 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
```
@@ -31,15 +27,15 @@ isCidr.v4('1:2:3:4:5:6:7:8/64');
### isCidr(input)
-Check if `input` is a IPv4 or IPv6 CIDR address.
+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.
### isCidr.v4(input)
-Check if `input` is a IPv4 CIDR address.
+Check if `input` is a IPv4 CIDR address. Returns a boolean.
### isCidr.v6(input)
-Check if `input` is a IPv6 CIDR address.
+Check if `input` is a IPv6 CIDR address. Returns a boolean.
## Related