Class Ipv6Addr

constructor

• new Ipv6Addr(value: bigint): Ipv6Addr

  Parameters

  • value: bigint

  Returns Ipv6Addr

• new Ipv6Addr(
      segments: [
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
      ],
  ): Ipv6Addr

  Parameters

  • segments: [number, number, number, number, number, number, number, number]

  Returns Ipv6Addr

Readonlyfamily

Static ReadonlyBITS

Static ReadonlyLOCALHOST

Static ReadonlyUNSPECIFIED

isBenchmarking

• isBenchmarking(): boolean

  Checks whether this address is in the benchmarking range.

  Returns boolean

  true when the address is in 2001:2::/48, otherwise false.

  See

  https://tools.ietf.org/html/rfc5180 and https://www.rfc-editor.org/errata_search.php?eid=1752

  Since

  v0.0.1

isDocumentation

• isDocumentation(): boolean

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

  Returns boolean

  true for 2001:db8::/32 or 3fff::/20, otherwise false.

  See

  https://tools.ietf.org/html/rfc3849 and https://tools.ietf.org/html/rfc9637

  Since

  v0.0.1

isGlobal

• isGlobal(): boolean

  Checks whether this address appears globally reachable.

  Returns boolean

  true when the address is not in known non-global special ranges.

  See

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

  Since

  v0.0.1

isIpv4Mapped

• isIpv4Mapped(): boolean

  Checks whether this address is an IPv4-mapped IPv6 address.

  Returns boolean

  true when the address is in ::ffff:0:0/96, otherwise false.

  Since

  v0.0.1

isLoopback

• isLoopback(): boolean

  Checks whether this address is the loopback address.

  Returns boolean

  true when the address is ::1, otherwise false.

  See

  https://tools.ietf.org/html/rfc4291#section-2.5.3

  Since

  v0.0.1

isMulticast

• isMulticast(): boolean

  Checks whether this address is a multicast address.

  Returns boolean

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

  See

  https://tools.ietf.org/html/rfc4291

  Since

  v0.0.1

isUnicast

• isUnicast(): boolean

  Checks whether this address is a unicast address.

  Returns boolean

  true when the address is not multicast, otherwise false.

  See

  https://tools.ietf.org/html/rfc4291

  Since

  v0.0.1

isUnicastGlobal

• isUnicastGlobal(): boolean

  Checks whether this address is a global unicast address.

  Returns boolean

  true when the address is unicast and not loopback, link-local, private, unspecified, or documentation.

  See

  https://tools.ietf.org/html/rfc4291#section-2.5.7

  Since

  v0.0.1

isUnicastLinkLocal

• isUnicastLinkLocal(): boolean

  Checks whether this address is a link-local unicast address.

  Returns boolean

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

  See

  https://tools.ietf.org/html/rfc4291

  Since

  v0.0.1

isUniqueLocal

• isUniqueLocal(): boolean

  Checks whether this address is in the unique-local range.

  Returns boolean

  true when the address is in fc00::/7, otherwise false.

  See

  https://tools.ietf.org/html/rfc4193

  Since

  v0.0.1

isUnspecified

• isUnspecified(): boolean

  Checks whether this address is the unspecified address.

  Returns boolean

  true when the address is ::, otherwise false.

  See

  https://tools.ietf.org/html/rfc4291

  Since

  v0.0.1

toBuffer

• toBuffer(littleEndian?: boolean): ArrayBuffer

  Encodes this address to a 16-byte buffer.

  Parameters

  • OptionallittleEndian: boolean

    Whether to use little-endian byte order. Defaults to false.

  Returns ArrayBuffer

  An ArrayBuffer containing the IPv6 integer value.

  Since

  v0.0.1

toIpv4

• toIpv4(): IOption<Ipv4Addr>

  Converts this address to IPv4 when compatible or mapped.

  Returns IOption<Ipv4Addr>

  An IPv4 address for ::a.b.c.d or ::ffff:a.b.c.d; otherwise None.

  Since

  v0.0.1

toIpv4Mapped

• toIpv4Mapped(): IOption<Ipv4Addr>

  Converts this address to IPv4 only when it is IPv4-mapped.

  Returns IOption<Ipv4Addr>

  An IPv4 address for ::ffff:a.b.c.d; otherwise None.

  Since

  v0.0.1

toString

• toString(): string

  Formats this address as a compressed IPv6 string.

  Returns string

  The shortest standard IPv6 text form.

  Since

  v0.0.1

Staticfrom

• from(value: string): IResult<Ipv6Addr>

  Creates an IPv6 address from text.

  Parameters

  • value: string

  Returns IResult<Ipv6Addr>

  A successful result with an IPv6 address, or an error when the input is invalid.

  Example

  const addr = Ipv6Addr.from('2001:db8::1').unwrap();
  Copy

  Since

  v0.0.1

StaticfromBuffer

• fromBuffer(buffer: ArrayBuffer, littleEndian?: boolean): IResult<Ipv6Addr>

  Creates an IPv6 address from a 16-byte buffer.

  Parameters

  • buffer: ArrayBuffer
  • OptionallittleEndian: boolean

  Returns IResult<Ipv6Addr>

  A successful result with an IPv6 address, or an error when the buffer cannot be read.

  Since

  v0.0.1