"Fossies" - the Fresh Open Source Software Archive

Member "node-v12.18.4-win-x86/node_modules/npm/node_modules/cidr-regex/README.md" (14 Feb 2020, 1865 Bytes) of package /windows/www/node-v12.18.4-win-x86.zip:


As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

cidr-regex

Regular expression for matching IP addresses in CIDR notation

Install

$ npm install --save cidr-regex

Usage

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

'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.

License

© silverwind, distributed under BSD licence

Based on previous work by Felipe Apostol