Class IPAddress<Type>

constructor

• new IPAddress<Type>(ip, type?): IPAddress<Type>

• Create a new IP Address

  Type Parameters

  • Type extends 4 | 6 = 4 | 6

  Parameters

  • ip: string | number | bigint | Uint8Array<ArrayBufferLike> | Uint16Array<ArrayBufferLike> | IPAddress<4 | 6>
  • Optional type: Type

  Returns IPAddress<Type>

  Example

  import { network } from "@rjweb/utils"
  
  const ip = new network.IPAddress('127.1')
  ip.type // 4
  ip.full() // 127.0.0.1
  ip.short() // 127.1
  Copy

  Since

  1.7.0

  Supports

  nodejs, browser

Readonly rawData

equals

• equals(compareTo): compareTo is IPAddress<Type>

• Whether this IP Equals another IP

  Parameters

  • compareTo: IPAddress<4 | 6>

  Returns compareTo is IPAddress<Type>

  Since

  1.8.5

hex

• hex(): string

• Get the Hexadecimal Representation of this IP

  Returns string

  Since

  1.12.25

int

• int(): Type extends 4
      ? Type<Type> extends 6
          ? number | bigint
          : number
      : bigint

• Get the Integer Representation of this IP

  Returns Type extends 4
      ? Type<Type> extends 6
          ? number | bigint
          : number
      : bigint

  Since

  1.8.6

isIPv4

• isIPv4(): this is IPAddress<4>

• Whether this is an IPv4 Address

  Returns this is IPAddress<4>

  Since

  1.7.0

isIPv6

• isIPv6(): this is IPAddress<6>

• Whether this is an IPv6 Address

  Returns this is IPAddress<6>

  Since

  1.7.0

long

• long(): string

• Get the Long representation of this IP

  Returns string

  Since

  1.7.0

reverse

• reverse(): string

• Get the Reverse Representation of this IP for PTR Records

  Returns string

  Since

  1.12.25

short

• short(): string

• Get the Short representation of this IP

  Returns string

  Since

  1.7.0

usual

• usual(): string

• Get the Usual representation of this IPs Version

  Returns .long() for v4 and .short() for v6

  Returns string

  Since

  1.8.5