Class Ipv4Addr

constructor

• new Ipv4Addr(num1: number, num2: number, num3: number, num4: number): Ipv4Addr

  Creates a new IPv4 address from four octets.

  Parameters

  • num1: number

    The first octet.

  • num2: number

    The second octet.

  • num3: number

    The third octet.

  • num4: number

    The fourth octet.

  Returns Ipv4Addr

  Throws

  If the integer values are not in the range of 0 to 255 for each octet.

  Throws

  If the input is not a number.

  Example

  new Ipv4Addr(192, 168, 0, 1) // creates the address `192.168.0.1`
  Copy

• new Ipv4Addr(integerValue: number): Ipv4Addr

  Creates a new IPv4 address from an integer value.

  Parameters

  • integerValue: number

    The integer representation of the IPv4 address.

  Returns Ipv4Addr

  Throws

  If the integer value is not in the range of 0 to 0xffffffff.

  Throws

  If the input is not a number.

  Example

  new Ipv4Addr(0xc0a80001) // creates the address `192.168.0.1` from the integer value `0xc0a80001`
  Copy

Readonlyfamily

Static ReadonlyBITS

Static ReadonlyBROADCAST

Static ReadonlyLOCALHOST

Static ReadonlyUNSPECIFIED

value

• get value(): number

  Gets the raw integer representation of the IPv4 address.

  Returns number

equals

• equals(other?: unknown): boolean

  Compares this IPv4 address with another for equality.

  Parameters

  • Optionalother: unknown

    instance of another address like to compare with.

  Returns boolean

  true if both addresses are equal, otherwise false.

  Since

  v0.1.0

isBenchmarking

• isBenchmarking(): boolean

  Checks whether this address is in the benchmarking range.

  Returns boolean

  true when the address is in 198.18.0.0/15, otherwise false.

  See

  https://datatracker.ietf.org/doc/html/rfc2544

  Since

  v0.0.1

isBroadcast

• isBroadcast(): boolean

  Checks whether this address is the broadcast address.

  Returns boolean

  true when the address is 255.255.255.255, otherwise false.

  See

  https://datatracker.ietf.org/doc/html/rfc919#section-7

  Since

  v0.0.1

isDocumentation

• isDocumentation(): boolean

  Checks whether this address is in a documentation-only range.

  Returns boolean

  true for 192.0.2.0/24, 198.51.100.0/24, or 203.0.113.0/24; otherwise false.

  See

  https://datatracker.ietf.org/doc/html/rfc5737

  Since

  v0.0.1

isGlobal

• isGlobal(): boolean

  Checks whether this address is globally reachable.

  Returns boolean

  true when the address is not in any special non-global range.

  See

  https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml

  Since

  v0.0.1

isLinkLocal

• isLinkLocal(): boolean

  Checks whether this address is link-local.

  Returns boolean

  true when the address is in 169.254.0.0/16, otherwise false.

  See

  https://datatracker.ietf.org/doc/html/rfc3927

  Since

  v0.0.1

isLoopback

• isLoopback(): boolean

  Checks whether this address is a loopback address.

  Returns boolean

  true when the address is in 127.0.0.0/8, otherwise false.

  See

  https://datatracker.ietf.org/doc/html/rfc1122

  Since

  v0.0.1

isMulticast

• isMulticast(): boolean

  Checks whether this address is a multicast address.

  Returns boolean

  true when the address is in 224.0.0.0/4, otherwise false.

  See

  https://datatracker.ietf.org/doc/html/rfc5771

  Since

  v0.0.1

isPrivate

• isPrivate(): boolean

  Checks whether this address is in a private-use range.

  Returns boolean

  true for 10.0.0.0/8, 172.16.0.0/12, or 192.168.0.0/16; otherwise false.

  See

  https://datatracker.ietf.org/doc/html/rfc1918

  Since

  v0.0.1

isReserved

• isReserved(): boolean

  Checks whether this address is in the reserved range.

  Returns boolean

  true when the address is in 240.0.0.0/4 except the broadcast address.

  See

  https://datatracker.ietf.org/doc/html/rfc1112

  Since

  v0.0.1

isShared

• isShared(): boolean

  Checks whether this address is in the shared Carrier-Grade NAT range.

  Returns boolean

  true when the address is in 100.64.0.0/10, otherwise false.

  See

  • https://datatracker.ietf.org/doc/html/rfc6598
  • https://doc.rust-lang.org/stable/std/net/struct.Ipv4Addr.html#method.is_shared

  Since

  v0.0.1

isUnspecified

• isUnspecified(): boolean

  Checks whether this address is the unspecified address.

  Returns boolean

  true when the address is 0.0.0.0, otherwise false.

  Since

  v0.0.1

  See

  https://doc.rust-lang.org/stable/std/net/struct.Ipv4Addr.html#method.is_unspecified

toBuffer

• toBuffer(littleEndian?: boolean): ArrayBuffer

  Encodes this address to a 4-byte buffer.

  Parameters

  • OptionallittleEndian: boolean

  Returns ArrayBuffer

  An ArrayBuffer containing the IPv4 integer value.

  Since

  v0.0.1

  Example

  const buffer: ArrayBuffer = addr.toBuffer();
  Copy

toIpv6

• toIpv6(): Ipv6Addr

  Converts this address to an IPv4-compatible Ipv6Addr.

  Returns Ipv6Addr

  An Ipv6Addr in the form ::a.b.c.d.

  Since

  v0.0.1

toIpv6Mapped

• toIpv6Mapped(): Ipv6Addr

  Converts this address to an IPv4-mapped Ipv6Addr.

  Returns Ipv6Addr

  An Ipv6Addr in the form ::ffff:a.b.c.d.

  Since

  v0.0.1

toOctets

• toOctets(): [number, number, number, number]

  Gets the four octets of this IPv4 address.

  Returns [number, number, number, number]

  An array containing the four octets [num1, num2, num3, num4].

  See

  https://doc.rust-lang.org/stable/std/net/struct.Ipv4Addr.html#method.octets

  Since

  v0.2.0

toString

• toString(): string

  Formats this address as dotted-decimal text.

  Returns string

  The IPv4 string representation, such as 192.168.0.1.

  Since

  v0.0.1

Staticfrom

• from(value: string): CoreResult<Ipv4Addr, TypeError>

  Creates an IPv4 address from dotted-decimal text.

  Parameters

  • value: string

  Returns CoreResult<Ipv4Addr, TypeError>

  A successful CoreResult with an Ipv4Addr, or an TypeError when the input is invalid.

  Example

  const addr: CoreResult<Ipv4Addr, TypeError> = Ipv4Addr.from('192.168.0.1');
  Copy

  Since

  v0.0.1

StaticfromBuffer

• fromBuffer(
      buffer: ArrayBuffer,
      littleEndian?: boolean,
  ): CoreResult<Ipv4Addr, Error>

  Creates an IPv4 address from a 4-byte buffer.

  Parameters

  • buffer: ArrayBuffer
  • OptionallittleEndian: boolean

  Returns CoreResult<Ipv4Addr, Error>

  A successful CoreResult with an Ipv4Addr, or an Error when the buffer cannot be read.

  Example

  const result: CoreResult<Ipv4Addr, Error> = Ipv4Addr.fromBuffer(buffer);
  Copy

  Since

  v0.0.1

StaticfromBufferOrThrow

• fromBufferOrThrow(buffer: ArrayBuffer, littleEndian?: boolean): Ipv4Addr

  Creates an IPv4 address from a 4-byte buffer and throws an error if the buffer cannot be read.

  Parameters

  • buffer: ArrayBuffer

    The 4-byte buffer containing the IPv4 address.

  • OptionallittleEndian: boolean

    Whether the buffer is in little-endian format. Defaults to false (big-endian).

  Returns Ipv4Addr

  The Ipv4Addr instance.

  Throws

  If the buffer cannot be read.

  Example

  const addr: Ipv4Addr = Ipv4Addr.fromBufferOrThrow(buffer);
  Copy

  Since

  v0.2.0

StaticfromOrThrow

• fromOrThrow(value: string): Ipv4Addr

  Creates an IPv4 address from text and throws an error if the input is invalid.

  Parameters

  • value: string

    The IPv4 address in string format.

  Returns Ipv4Addr

  The Ipv4Addr instance.

  Throws

  If the input is not a valid IPv4 address.

  Example

  const addr: Ipv4Addr = Ipv4Addr.fromOrThrow('192.168.0.1');
  Copy

  Since

  v0.2.0