Package Exports
- cidr-regex
- cidr-regex/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cidr-regex) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
cidr-regex
Regular expression for matching IP addresses in CIDR notation
Usage
$ npm i cidr-regex
const cidrRegex = require("cidr-regex");
// Contains a CIDR IP address?
cidrRegex().test("foo 192.168.0.1/24");
//=> true
// 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
// 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"]
API
cidrRegex([options])
Returns a regex for matching both IPv4 and IPv6 CIDR IP addresses.
cidrRegex.v4([options])
Returns a regex for matching IPv4 CIDR IP addresses.
cidrRegex.v6([options])
Returns a regex for matching IPv6 CIDR IP addresses.
options.exact
Type: boolean
Default: false
(Matches any CIDR IP address in a string)
Only match an exact string. Useful with RegExp#test()
to check if a string is a CIDR IP address.
Related
- is-cidr - Check if a string is an IP address in CIDR notation
- is-ip - Check if a string is an IP address
- ip-regex - Regular expression for matching IP addresses
- cidr-tools - Tools to work with IPv4 and IPv6 CIDR network lists
License
© silverwind, distributed under BSD licence
Based on previous work by Felipe Apostol