Skip to content
A package to calculate subnet masks.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
test
.editorconfig
.eslintignore
.eslintrc.json
.gitattributes
.gitignore
.npmrc
.prettierrc
.travis.yml
CHANGELOG.md
LICENSE
README.md
appveyor.yml
circle.yml
package.json

README.md

IPv4 Parser

Generated by OSS Project Generator.

Travis Status AppVeyor Status CircleCI Status Coveralls Status NPM Version License

A package to calculate subnet masks.

This package provides the following features:

  • Allows you to parse an IPv4 address
  • Provides the address, size, netmask, first and last addresses.
  • Each address provides decimal, binary and hexadecimal values.

Installation

There are two ways to install node-ipv4: globally and locally.

To install globally:

# Install globally
$ npm install -g node-ipv4

# Check installation
$ node-ipv4 --version

To install locally:

$ npm install node-ipv4

Usage

There are two ways to use node-ipv4: globally and locally.

Globally

  • -V or --version: output the version number

$ node-ipv4 --version
1.1.2
  • -h or --help: output usage information

$ node-ipv4 --help

  Usage: cli [options]

  Options:

    -h, --help         output usage information
    -V, --version      output the version number
    -i, --ip [ip]      IP Address
    -c, --cidr [cidr]  Cdir block
  • -i or --ip [ip: string]: enter the IP address

  • -c or --cidr [ip: number]: enter the CIDR block

# without alias
$ node-ipv4 --ip 192.168.1.1 --cidr 8

# with alias
$ node-ipv4 -i 192.168.1.1 -c 8

# output
{
  "cidr": 8,
  "size": 16777216,
  "address": {
    "value": 3232235777,
    "address": "192.168.1.1",
    "binary": "11000000101010000000000100000001",
    "hexadecimal": "C0A80101"
  },
  "netmask": {
    "value": 4278190080,
    "address": "255.0.0.0",
    "binary": "11111111000000000000000000000000",
    "hexadecimal": "FF000000"
  },
  "first": {
    "value": 3221225472,
    "address": "192.0.0.0",
    "binary": "11000000000000000000000000000000",
    "hexadecimal": "C0000000"
  },
  "last": {
    "value": 3238002687,
    "address": "192.255.255.255",
    "binary": "11000000111111111111111111111111",
    "hexadecimal": "C0FFFFFF"
  }
}

Locally

const ipv4 = require('node-ipv4');

ipv4.parse('192.168.1.1', 16, (err, subnet) => {
  if (err) return console.error(err);

  console.log(subnet);
});

Output

{
  "cidr": 16,
  "size": 65536,
  "address": {
    "value": 3232235777,
    "address": "192.168.1.1",
    "binary": "11000000101010000000000100000001",
    "hexadecimal": "C0A80101"
  },
  "netmask": {
    "value": 4294901760,
    "address": "255.255.0.0",
    "binary": "11111111111111110000000000000000",
    "hexadecimal": "FFFF0000"
  },
  "first": {
    "value": 3232235520,
    "address": "192.168.0.0",
    "binary": "11000000101010000000000000000000",
    "hexadecimal": "C0A80000"
  },
  "last": {
    "value": 3232301055,
    "address": "192.168.255.255",
    "binary": "11000000101010001111111111111111",
    "hexadecimal": "C0A8FFFF"
  }
}

Documentation

Address

  • value: {Number} Decimal value of an address
  • address: {String} String value of an address
  • binary: {String} Binary value of an address
  • hexadecimal: {String} Hexadecimal value of an address

IPv4

  • cidr: {Number} CIDR block
  • size: {Number} Size of subnet
  • address: {Object:Address} The input address
  • netmask: {Object:Address} The subnet mask
  • first: {Object:Address} The first address
  • last: {Object:Address} The last address

API: parse(address, cidr, callback)

  • address {String} IP address
  • cidr {Number} CIDR block
  • callback {Function}
    • err {Error | null} Error
    • ipv4 {Object:IPv4} Instance of IPv4

Development

  • Clone the repo
$ git clone https://github.com/robertoachar/node-ipv4.git
  • Install dependencies
$ npm install
  • Running scripts
Action Usage
Linting code npm run lint
Running unit tests npm run jest
Running code coverage npm run coverage
Running lint + tests npm test
Sending coverage results to Coveralls.io npm run coveralls

Author

Roberto Achar

License

MIT

You can’t perform that action at this time.