Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

ip-regex

Package Overview
Dependencies
0
Maintainers
1
Versions
12
Issues
File Explorer

Advanced tools

ip-regex

Regular expression for matching IP addresses (IPv4 & IPv6)

    5.0.0latest

Version published
Maintainers
1
Weekly downloads
10,750,879
decreased by-1.7%

Weekly downloads

Changelog

Source

Breaking

  • Require Node.js 12 87a85ab
  • This package is now pure ESM. Please read this.

https://github.com/sindresorhus/ip-regex/compare/v4.3.0...v5.0.0

Readme

Source

ip-regex

Regular expression for matching IP addresses

Install

$ npm install ip-regex

This module targets Node.js 12 or later and the latest version of Chrome, Firefox, and Safari. If you want support for older browsers, use version 2.1.0: npm install [email protected]

Usage

import ipRegex from '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'] // Contains an IP address? ipRegex({includeBoundaries: true}).test('192.168.0.2000000000'); //=> false // Matches an IP address? '192.168.0.2000000000'.match(ipRegex({includeBoundaries: true})); //=> null

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

Type: object

exact

Type: boolean
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.

includeBoundaries

Type: boolean
Default: false

Include boundaries in the regex. When true, 192.168.0.2000000000 will report as an invalid IPv4 address. If this option is not set, the mentioned IPv4 address would report as valid (ignoring the trailing zeros).

  • is-ip - Check if a string is an IP address
  • is-cidr - Check if a string is an IP address in CIDR notation
  • cidr-regex - Regular expression for matching IP addresses in CIDR notation

Keywords

FAQs

What is ip-regex?

Regular expression for matching IP addresses (IPv4 & IPv6)

Is ip-regex popular?

The npm package ip-regex receives a total of 9,347,592 weekly downloads. As such, ip-regex popularity was classified as popular.

Is ip-regex well maintained?

We found that ip-regex demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 01 Jan 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc