You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
# ip-regex [![Build Status](https://travis-ci.org/sindresorhus/ip-regex.svg?branch=master)](https://travis-ci.org/sindresorhus/ip-regex)
> Regular expression for matching IP addresses
## Install
``` $ npm install --save ip-regex ```
## Usage
```js const ipRegex = require('ip-regex');
// Contains an IP address? ipRegex().test('unicorn 192.168.0.1'); //=> true
// Is an IP address? ipRegex({exact: true}).test('unicorn 192.168.0.1'); //=> false
ipRegex.v6({exact: true}).test('1:2:3:4:5:6:7:8'); //=> true
'unicorn 192.168.0.1 cake 1:2:3:4:5:6:7:8 rainbow'.match(ipRegex()); //=> ['192.168.0.1', '1:2:3:4:5:6:7:8'] ```
## API
### ipRegex([options])
Returns a regex for matching both IPv4 and IPv6.
### ipRegex.v4([options])
Returns a regex for matching IPv4.
### ipRegex.v6([options])
Returns a regex for matching IPv6.
#### options.exact
Type: `boolean`<br> Default: `false` *(Matches any IP address in a string)*
Only match an exact string. Useful with `RegExp#test()` to check if a string is an IP address.
## Related
- [is-ip](https://github.com/sindresorhus/is-ip) - Check if a string is an IP address
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)
|