Class IP

Hierarchy

  • IP

Constructors

constructor

Properties

ip v4allrouter v4allsys v4bcast v4zero v6interfacelocalallnodes v6linklocalallnodes v6linklocalallrouters v6loopback v6unspecified v6zero

Accessors

isGlobalUnicast isInterfaceLocalMulticast isLinkLocalMulticast isLinkLocalUnicast isLoopback isMulticast isPrivate isUnspecified length

Methods

defaultMask equal mask to16 to4 toString parse v4

Constructors

constructor

Properties

Readonly ip

ip: Uint8Array

Static v4allrouter

v4allrouter: IP = ...

Static v4allsys

v4allsys: IP = ...

Static v4bcast

v4bcast: IP = ...

Static v4zero

v4zero: IP = ...

Static v6interfacelocalallnodes

v6interfacelocalallnodes: IP = ...

Static v6linklocalallnodes

v6linklocalallnodes: IP = ...

Static v6linklocalallrouters

v6linklocalallrouters: IP = ...

Static v6loopback

v6loopback: IP = ...

Static v6unspecified

v6unspecified: IP = ...

Static v6zero

v6zero: IP = ...

Accessors

isGlobalUnicast

  • get isGlobalUnicast(): boolean

  • reports whether ip is a global unicast address.

    Remarks

    The identification of global unicast addresses uses address type identification as defined in RFC 1122, RFC 4632 and RFC 4291 with the exception of IPv4 directed broadcast addresses. It returns true even if ip is in IPv4 private address space or local IPv6 unicast address space.

    Returns boolean

isInterfaceLocalMulticast

  • get isInterfaceLocalMulticast(): boolean

  • reports whether ip is an interface-local multicast address.

    Returns boolean

isLinkLocalMulticast

  • get isLinkLocalMulticast(): boolean

  • reports whether ip is a link-local multicast address.

    Returns boolean

isLinkLocalUnicast

  • get isLinkLocalUnicast(): boolean

  • reports whether ip is a link-local unicast address.

    Returns boolean

isLoopback

  • get isLoopback(): boolean

  • reports whether ip is a loopback address.

    Returns boolean

isMulticast

  • get isMulticast(): boolean

  • reports whether ip is a multicast address.

    Returns boolean

isPrivate

  • get isPrivate(): boolean

  • reports whether ip is a private address, according to RFC 1918 (IPv4 addresses) and RFC 4193 (IPv6 addresses).

    Returns boolean

isUnspecified

  • get isUnspecified(): boolean

  • reports whether ip is an unspecified address, either the IPv4 address "0.0.0.0" or the IPv6 address "::".

    Returns boolean

length

Methods

defaultMask

  • returns the default IP mask for the IP address ip.

    Remarks

    Only IPv4 addresses have default masks; DefaultMask returns undefined if ip is not a valid IPv4 address.

    Returns undefined | IPMask

equal

  • reports whether ip and o are the same IP address. An IPv4 address and that same address in IPv6 form are considered to be equal.

    Parameters

    Returns boolean

mask

  • returns the result of masking the IP address ip with mask.

    Parameters

    Returns undefined | IP

to16

  • converts the IP address ip to a 16-byte representation.

    Remarks

    If ip is not an IP address (it is the wrong length), to16 returns undefined.

    Returns undefined | IP

to4

  • converts the IPv4 address ip to a 4-byte representation.

    Remarks

    If ip is not an IPv4 address, To4 returns nil.

    Returns undefined | IP

toString

  • returns the string form of the IP address ip.

    Remarks

    It returns one of 4 forms:

    • "", if ip has length 0
    • dotted decimal ("192.0.2.1"), if ip is an IPv4 or IP4-mapped IPv6 address
    • IPv6 ("2001:db8::1"), if ip is a valid IPv6 address
    • the hexadecimal form of ip, without punctuation, if no other cases apply

    Returns string

Static parse

  • parses s as an IP address, returning the result.

    Remarks

    The string s can be in IPv4 dotted decimal ("192.0.2.1"), IPv6 ("2001:db8::68"), or IPv4-mapped IPv6 ("::ffff:192.0.2.1") form. If s is not a valid textual representation of an IP address, parse returns nil.

    Parameters

    • s: string

    Returns undefined | IP

Static v4

  • returns the IP address (in 16-byte form) of the IPv4 address a.b.c.d.

    Parameters

    • a: number
    • b: number
    • c: number
    • d: number

    Returns IP

Settings

Member Visibility

Theme

Generated using TypeDoc