is ip

Check if a string is an IP address.

Like Node's net.isIP function, but in userland.

See the docs

install

npm i -S @substrate-system/is-ip
Copy

Formats

This exposes ESM and common JS via package.json exports field.

ESM

import { isIP } from '@substrate-system/is-ip'
Copy

Common JS

const isIP = require('@substrate-system/is-ip')
Copy

pre-built JS

This package exposes minified JS files too. Copy them to a location that is accessible to your web server, then link to them in HTML.

copy

cp ./node_modules/@namespace/package/dist/module.min.js ./public
Copy

HTML

<script type="module" src="./module.min.js"></script>
Copy

Example

Return either 0, 4, or 6 depending on the type of IP address.

import { isIP } from '@substrate-system/is-ip'

isIP('::1')  // returns 6
isIP('127.0.0.1')  // returns 4
isIP('127.000.000.001')  // returns 0
isIP('127.0.0.1/24')  // returns 0
isIP('fhqwhgads')  // returns 0
Copy