cidr-regex
v4.1.1
Published
Regular expression for matching IP addresses in CIDR notation
Downloads
3,192,576
Readme
cidr-regex
Regular expression for matching IP addresses in CIDR notation
Usage
$ npm i cidr-regex
import cidrRegex from "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
- ip-bigint - Convert IPv4 and IPv6 addresses to native BigInt and vice-versa
- ip-regex - Regular expression for matching IP addresses
- is-cidr - Check if a string is an IP address in CIDR notation
- is-ip - Check if a string is an IP address
- 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