Functions — github.com/beaugunderson/ip-address

hub / github.com/beaugunderson/ip-address / functions

Functions148 in github.com/beaugunderson/ip-address

⨍ Functions 148◇ Types & classes 10

↓ 1 callersFunctionrenderClass

(cls: TypeDoc.DeclarationReflection)

scripts/build-readme.ts:127

↓ 1 callersFunctionrenderMethod

(method: TypeDoc.DeclarationReflection)

scripts/build-readme.ts:68

↓ 1 callersFunctionrenderProperty

(prop: TypeDoc.DeclarationReflection)

scripts/build-readme.ts:85

↓ 1 callersFunctionrenderPropertyType

* Properties holding a function (the prototype-assigned `isInSubnet` and * friends) render through the same parameter rules as methods, so a `this`

scripts/build-readme.ts:56

↓ 1 callersFunctionrenderSummaryLine

* The one-line blurb shown next to the class name on the collapsed row. The * summary is markdown, but a `<summary>` element renders HTML rather than

scripts/build-readme.ts:111

↓ 1 callersMethodreverseForm

* Return the reversed in-addr.arpa form of the address, e.g. * `42.2.0.192.in-addr.arpa.` for `192.0.2.42`. * @param {Object} options * @para

src/ipv4.ts:437

↓ 1 callersFunctionsimpleRegularExpression

(groups: string[])

src/v6/regular-expressions.ts:17

↓ 1 callersFunctionspanAllZeroes

(s: string)

src/v6/helpers.ts:13

↓ 1 callersMethodstartAddress

* The first address in the range given by this address' subnet. * Often referred to as the Network Address. * @returns {Address4}

src/ipv4.ts:286

↓ 1 callersMethodto6to4

* Return a v6 6to4 address from a v6 v4inv6 address * @returns {Address6}

src/ipv6.ts:1037

↓ 1 callersMethodtoAddress4Nat64

* Extract the embedded IPv4 address from a NAT64 IPv6 address using the * encoding defined by [RFC 6052](https://datatracker.ietf.org/doc/html/rfc6

src/ipv6.ts:1106

↓ 1 callersMethodtoArray

* Converts an IPv4 address object to an array of bytes. * * To get a Node.js `Buffer`, wrap the result: `Buffer.from(address.toArray())`. * @

src/ipv4.ts:242

↓ 1 callersMethodtoGroup6

* Converts an IPv4 address object to an IPv6 address group * @returns {String}

src/ipv4.ts:250

↓ 1 callersFunctionzeros

(count: number)

test/functionality-v6-test.ts:1601

FunctionassertByteArray

( bytes: number[], byteCount: number, family: 'IPv4' | 'IPv6', minimum: number, )

src/common.ts:87

Methodconstructor

(message: string, parseMessage?: string)

src/address-error.ts:15

Methodconstructor

(address: string, optionalGroups?: number)

* The last address in the range given by this address' subnet * Often referred to as the Broadcast * @returns {Address4}

src/ipv4.ts:313

MethodendAddressExclusive

* The last host address in the range given by this address's subnet ie * the last address prior to the Broadcast Address * @returns {Address4}

src/ipv4.ts:322

MethodfromAddressAndMask

* Construct an `Address4` from an address and a dotted-decimal subnet * mask given as separate strings (e.g. as returned by Node's * `os.network

src/ipv4.ts:110

MethodfromAddressAndWildcardMask

* Construct an `Address4` from an address and a Cisco-style wildcard mask * given as separate strings (e.g. `0.0.0.255` for a `/24`). The wildcard

src/ipv4.ts:124

MethodfromArpa

* Return an address from in-addr.arpa form * @param {string} arpaFormAddress - an 'in-addr.arpa' form ipv4 address * @returns {Adress4} * @ex

src/ipv4.ts:219

MethodfromByteArray

* Convert a byte array to an Address4 object. Throws `AddressError` unless * given exactly 4 integers from 0 to 255. Signed bytes are rejected, so

src/ipv4.ts:384

MethodfromWildcard

* Construct an `Address4` from a wildcard pattern with trailing `*` * octets. The number of trailing wildcards determines the prefix * length: e

src/ipv4.ts:145

MethodisBroadcast

* Returns true if the address is the limited broadcast address `255.255.255.255` ([RFC 919](https://datatracker.ietf.org/doc/html/rfc919)). * @retu

src/ipv4.ts:511

MethodisCGNAT

* Returns true if the address is in the carrier-grade NAT range `100.64.0.0/10` ([RFC 6598](https://datatracker.ietf.org/doc/html/rfc6598)). * @ret

src/ipv4.ts:519

FunctionisCorrect

(defaultBits: number)

src/common.ts:43

FunctionisHostInSubnet

(this: Address4 | Address6, address: Address4 | Address6)

src/common.ts:39

FunctionisInSubnet

(this: Address4 | Address6, address: Address4 | Address6)

src/common.ts:19

MethodisLinkLocal

* Returns true if the address is in the link-local range `169.254.0.0/16` ([RFC 3927](https://datatracker.ietf.org/doc/html/rfc3927)). * @returns {

src/ipv4.ts:495

MethodisLoopback

* Returns true if the address is in the loopback range `127.0.0.0/8` ([RFC 1122](https://datatracker.ietf.org/doc/html/rfc1122)). * @returns {boole

src/ipv4.ts:487

MethodisMulticast

* Returns true if the given address is a multicast address * @returns {boolean}

src/ipv4.ts:471

MethodisPrivate

* Returns true if the address is in one of the [RFC 1918](https://datatracker.ietf.org/doc/html/rfc1918) private address ranges (`10.0.0.0/8`, `172.16

src/ipv4.ts:479

MethodisUnspecified

* Returns true if the address is the unspecified address `0.0.0.0`. * @returns {boolean}

src/ipv4.ts:503

MethodisValid

* Returns true if the given string is a valid IPv4 address (with optional * CIDR subnet), false otherwise. Host bits in the subnet portion are *

src/ipv4.ts:53

MethodnetworkForm

* The network address in CIDR string form, e.g. `192.168.1.0/24` for * `192.168.1.5/24`. For an address with no explicit subnet the prefix is *

FunctionprefixLengthFromMask

(value: bigint, totalBits: number)

src/common.ts:62

FunctionsimpleGroup

(addressString: string, offset: number = 0)

src/v6/helpers.ts:48

FunctionspanAll

(s: string, offset: number = 0)

src/v6/helpers.ts:20

FunctionspanLeadingZeroes

(address: string)

src/v6/helpers.ts:38

FunctionspanLeadingZeroes4

(n: string)

src/ipv6.ts:35

MethodstartAddressExclusive

* The first host address in the range given by this address's subnet ie * the first address after the Network Address * @returns {Address4}

src/ipv4.ts:295

FunctionstringToPaddedHex

(numberString: string)

src/common.ts:108

MethodsubnetMaskAddress

* The dotted-decimal form of the subnet mask, e.g. `255.255.240.0` for * a `/20`. Returns an `Address4`; call `.correctForm()` for the string. *

* The Cisco-style wildcard mask, e.g. `0.0.0.255` for a `/24`. This is * the bitwise inverse of `subnetMaskAddress()`. Returns an `Address4`; *

src/ipv4.ts:344

← previous101–148 of 148, ranked by callers