Logo for jsDocs.io

ipaddr.js

  • Version 2.2.0
  • Published
  • 62.3 kB
  • No dependencies
  • MIT license

Install

npm i ipaddr.js
yarn add ipaddr.js
pnpm add ipaddr.js

Overview

A library for manipulating IPv4 and IPv6 addresses in JavaScript.

Index

Namespaces

Namespaces

namespace ipaddr.js

module 'ipaddr.js' {}

    function fromByteArray

    fromByteArray: (bytes: number[]) => IPv4 | IPv6;

      function isValid

      isValid: (addr: string) => boolean;

        function isValidCIDR

        isValidCIDR: (addr: string) => boolean;

          function parse

          parse: (addr: string) => IPv4 | IPv6;

            function parseCIDR

            parseCIDR: (mask: string) => [IPv4 | IPv6, number];

              function process

              process: (addr: string) => IPv4 | IPv6;

                function subnetMatch

                subnetMatch: (
                    addr: IPv4 | IPv6,
                    rangeList: RangeList<IPv4 | IPv6>,
                    defaultName?: string
                ) => string;

                  class IPv4

                  class IPv4 extends IP {}

                    constructor

                    constructor(octets: number[]);

                      property octets

                      octets: number[];

                        method broadcastAddressFromCIDR

                        static broadcastAddressFromCIDR: (addr: string) => IPv4;

                          method isIPv4

                          static isIPv4: (addr: string) => boolean;

                            method isValid

                            static isValid: (addr: string) => boolean;

                              method isValidCIDR

                              static isValidCIDR: (addr: string) => boolean;

                                method isValidFourPartDecimal

                                static isValidFourPartDecimal: (addr: string) => boolean;

                                  method kind

                                  kind: () => 'ipv4';

                                    method match

                                    match: (what: IPv4 | IPv6 | [IPv4 | IPv6, number], bits?: number) => boolean;

                                      method networkAddressFromCIDR

                                      static networkAddressFromCIDR: (addr: string) => IPv4;

                                        method parse

                                        static parse: (addr: string) => IPv4;

                                          method parseCIDR

                                          static parseCIDR: (addr: string) => [IPv4, number];

                                            method range

                                            range: () => IPv4Range;

                                              method subnetMaskFromPrefixLength

                                              static subnetMaskFromPrefixLength: (prefix: number) => IPv4;

                                                method subnetMatch

                                                subnetMatch: (rangeList: RangeList<IPv4>, defaultName?: string) => string;

                                                  method toIPv4MappedAddress

                                                  toIPv4MappedAddress: () => IPv6;

                                                    class IPv6

                                                    class IPv6 extends IP {}

                                                      constructor

                                                      constructor(parts: number[]);

                                                        property parts

                                                        parts: number[];

                                                          property zoneId

                                                          zoneId?: string;

                                                            method broadcastAddressFromCIDR

                                                            static broadcastAddressFromCIDR: (addr: string) => IPv6;

                                                              method isIPv4MappedAddress

                                                              isIPv4MappedAddress: () => boolean;

                                                                method isIPv6

                                                                static isIPv6: (addr: string) => boolean;

                                                                  method isValid

                                                                  static isValid: (addr: string) => boolean;

                                                                    method isValidCIDR

                                                                    static isValidCIDR: (addr: string) => boolean;

                                                                      method kind

                                                                      kind: () => 'ipv6';

                                                                        method match

                                                                        match: (what: IPv4 | IPv6 | [IPv4 | IPv6, number], bits?: number) => boolean;

                                                                          method networkAddressFromCIDR

                                                                          static networkAddressFromCIDR: (addr: string) => IPv6;

                                                                            method parse

                                                                            static parse: (addr: string) => IPv6;

                                                                              method parseCIDR

                                                                              static parseCIDR: (addr: string) => [IPv6, number];

                                                                                method range

                                                                                range: () => IPv6Range;

                                                                                  method subnetMaskFromPrefixLength

                                                                                  static subnetMaskFromPrefixLength: (prefix: number) => IPv6;

                                                                                    method subnetMatch

                                                                                    subnetMatch: (rangeList: RangeList<IPv6>, defaultName?: string) => string;

                                                                                      method toIPv4Address

                                                                                      toIPv4Address: () => IPv4;

                                                                                        method toRFC5952String

                                                                                        toRFC5952String: () => string;

                                                                                          Package Files (1)

                                                                                          Dependencies (0)

                                                                                          No dependencies.

                                                                                          Dev Dependencies (2)

                                                                                          Peer Dependencies (0)

                                                                                          No peer dependencies.

                                                                                          Badge

                                                                                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ipaddr.js.

                                                                                          • Markdown
                                                                                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/ipaddr.js)
                                                                                          • HTML
                                                                                            <a href="https://www.jsdocs.io/package/ipaddr.js"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>