Socket
Socket
Sign inDemoInstall

ip-address

Package Overview
Dependencies
2
Maintainers
1
Versions
48
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    ip-address

A library for parsing IPv4 and IPv6 IP addresses in node and the browser.


Version published
Weekly downloads
9.7M
increased by0.55%
Maintainers
1
Install size
258 kB
Created
Weekly downloads
 

Package description

What is ip-address?

The ip-address npm package provides utilities for handling, validating, and manipulating IPv4 and IPv6 addresses in JavaScript. It's useful for applications that need to work with IP addresses, whether it's for networking, security, or data analysis purposes.

What are ip-address's main functionalities?

Parsing and validating IP addresses

This feature allows you to parse and validate IPv4 and IPv6 addresses. The example demonstrates how to create IPv4 and IPv6 objects from string representations of the addresses.

const {IPv4, IPv6} = require('ip-address');
let ipv4 = new IPv4('192.168.0.1');
let ipv6 = new IPv6('2001:0db8:85a3:0000:0000:8a2e:0370:7334');

Checking if an IP address is in a subnet

This feature enables checking if an IP address belongs to a specific subnet. The code sample checks if the '192.168.1.1' address is within the '192.168.1.0/24' subnet.

const {IPv4} = require('ip-address');
let ipv4 = new IPv4('192.168.1.1');
console.log(ipv4.isInSubnet(new IPv4('192.168.1.0/24')));

Converting IP addresses to binary representation

This feature allows converting IP addresses to their binary representation. The example converts the IPv4 address '192.168.1.1' to its binary form.

const {IPv4} = require('ip-address');
let ipv4 = new IPv4('192.168.1.1');
console.log(ipv4.binaryZeroPad());

Other packages similar to ip-address

Readme

Source

CircleCI codecov downloads npm snyk

ip-address

ip-address is a library for validating and manipulating IPv4 and IPv6 addresses in JavaScript.

Migrating from 6.x to 7.x

ip-address was rewritten in TypeScript for version 7. If you were using version 6 you'll need to make these changes to upgrade:

  • Instead of checking isValid(), which has been removed, you'll need to use a try/catch if you're accepting unknown input. This made the TypeScript types substantially easier as well as allowed the use of an AddressError class which will contain a parseMessage if an error occurred in the parsing step.
  • Instead of using the error, parseError, and valid attributes you'll need to use the message and parseMessage of the thrown AddressError.

Documentation

Documentation is available at ip-address.js.org.

Examples

var Address6 = require('ip-address').Address6;

var address = new Address6('2001:0:ce49:7601:e866:efff:62c3:fffe');

var teredo = address.inspectTeredo();

teredo.client4;    // '157.60.0.1'

Features

  • Usable via CommonJS or ESM
  • Parsing of all IPv6 notations
  • Parsing of IPv6 addresses and ports from URLs with Address6.fromURL(url)
  • Validity checking
  • Decoding of the Teredo information in an address
  • Whether one address is a valid subnet of another
  • What special properties a given address has (multicast prefix, unique local address prefix, etc.)
  • Number of subnets of a certain size in a given address
  • Display methods
    • Hex, binary, and decimal
    • Canonical form
    • Correct form
    • IPv4-compatible (i.e. ::ffff:192.168.0.1)
  • Works in node and the browser (with browserify)
  • ~1,600 test cases

Used by

Keywords

FAQs

Last updated on 25 Sep 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc