npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@badrap/ipv46

v2.2.3

Published

Parse, format and compare IPv4/6 addresses

Downloads

52

Readme

ipv46 CI npm JSR

ipv46 is a small JavaScript library for parsing, formatting and sorting IPv4/6 addresses. It works on both Node.js and browser environments.

[!NOTE] While this package is still evolving, we're currently not accepting any new feature requests or suggestions. Please use the issue tracker for bug reports and security concerns, which we highly value and welcome. Thank you for your understanding ❤️

Installation

$ npm install @badrap/ipv46

Usage

import { IP } from "@badrap/ipv46";

IP.parse(string)

Returns the given string parsed into an IPv4 or IPv6 address object. If the string is not a valid address then the result is null.

IP.parse("192.0.2.1"); // IPv4 { ... }
IP.parse("2001:db8::1"); // IPv6 { ... }
IP.parse("non-address"); // null

IP.parse supports IPv6 addresses with embedded IPv4 addresses.

IP.parse("2001:db8::192.0.2.1"); // IPv6 { ... }

IP#version

Valid IPv4/6 address objects have their version as an attribute.

IP.parse("192.0.2.1").version; // 4
IP.parse("2001:db8::1").version; // 6

IP#toString()

Address objects implement the toString method for turning the addresses back into strings. The strings are printed lower-cased sans any extra leading zeroes. IPv6 formatting follows the RFC 5952 recommendations, except that formatting doesn't output IPv6 addresses with embedded IPv4 addresses.

IP.parse("192.0.2.1").toString(); // '192.0.2.1'
IP.parse("2001:db8::1").toString(); // '2001:db8::1'
IP.parse("2001:db8::192.0.2.1").toString(); // '2001:db8::c000:201'

IP.cmp(other)

Compare and sort addresses. IP.cmp(a, b) returns:

  • -1 if a is sorted before b
  • 0 if a equals b
  • 1 otherwise
const a = IP.parse("192.0.2.1");
const b = IP.parse("203.0.113.0");

IP.cmp(a, a); // 0
IP.cmp(a, b); // -1
IP.cmp(b, a); // 1

IPv4 addresses are always sorted before IPv6 addresses.

const ipv4 = IP.parse("192.0.2.1");
const ipv6 = IP.parse("2001:db8::1");

IP.cmp(ipv4, ipv6); // -1

Parsed addresses get normalized. For example extra leading zeroes don't matter in comparisons.

const a = IP.parse("2001:0db8::1");
const b = IP.parse("2001:0db8:0000::0001");

IP.cmp(a, b); // 0

IP.cmp is directly compatible with Array#sort.

const a = IP.parse("2001:0db8::2");
const b = IP.parse("2001:0db8::1");
const c = IP.parse("2001:0db8::")

  [(a, b, c)].sort(IP.cmp); // [c, b, a]