README.md

@amuject/ip

IP module for calculation (demical, subnet) / check bogon.

Table of Content

• Installation
• Use IP
• Simple Example
• API
  • Class: IP
    • new IP(value)
    • ip.toString()
    • ip.toDemical()
    • ip.is4()
    • ip.is6()
    • ip.to6()
    • ip.hasSubnet()
    • ip.getSubnet()
    • ip.getSubnetIPs()
    • ip.in(from[, to])
    • ip.isBogon()
    • ip.getBogon()

Installation

npm i @wnynya/ip

Use IP

ESM

import IP from '@wnynya/ip';
const ip = new IP('127.0.0.1');

CJS

const IP = require('@wnynya/ip');
const ip = new IP('127.0.0.1');

Typescript

import IP from '@wnynya/ip';
const ip: IP = new IP('127.0.0.1');

Simple Example

// Convert IPv4 string to demical & check IP is bogon.
import IP from '@wnynya/ip'; // ESM

const ip = new IP('127.0.0.1');

console.log(ip.toDemical()); // true
console.log(ip.isBogon()); // true

console.log(ip.in(new IP('127.0.0.1', '127.0.0.255'))); // true
console.log(ip.in(new IP('127.0.1.0/24'))); // false

API

Class: IP

new IP(value)

• value <string|number|bigint> IP value.

ip.toString()

• Returns: <string>

Returns full string of IP.

ip.toDemical()

• Returns: <bigint>

Returns demical value of IP.

ip.is4()

• Returns: <boolean>

Check IP is IPv4.

ip.is6()

• Returns: <boolean>

Check IP is IPv6.

ip.to6()

• Returns: <IP>

Convert IPv4 IP to IPv6 IP

ip.hasSubnet()

• Returns: <boolean>

Check IP has subnet mask (suffix).

ip.getSubnet()

• Returns: <Object>

Returns subnet range.

ip.getSubnetIPs()

• Returns: <IP[]>

Returns array of subnet range IPs.

ip.in(from[, to])

• from <IP> IP value.

• to <IP> IP value.

• Returns: <boolean>

Check IP is in range. If from IP has subnet range, Check IP is in subnet range.

ip.isBogon()

• Returns: <boolean>

Check IP is bogon.

ip.getBogon()

• Returns: <string>

If IP is bogon, returns reason of bogon.