Class Subnet<T>

constructor

• new Subnet<T extends IPv4 | IPv6>(address: T, suffix: number): Subnet<T>

  Create new subnet instance

  Type Parameters

  • T extends IPv4 | IPv6

  Parameters

  • address: T

    An IP address
  • suffix: number

    Subnet suffix bits

  Returns Subnet<T>

  Throws

  RangeError If the suffix is greater than the IP address family bit-length

Readonlyaddress

Readonlysuffix

Static ReadonlyIPV4_MAPPED_IPV6

[iterator]

• "[iterator]"(): IterableIterator<T>

  Iterate all IP addresses in this subnet

  NOTE: This can be slow for large subnets. If you need to check if an IP address is in the subnet, use Subnet#contains.

  Returns IterableIterator<T>

broadcast

• broadcast(): T

  Get the last IP address in the subnet (i.e. broadcast address)

  Returns T

has

• has(address: T): boolean

  Check if the provided IP address is in this subnet

  Parameters

  • address: T

  Returns boolean

iterate

• iterate(): IterableIterator<T>

  Iterate all IP addresses in this subnet

  NOTE: This can be slow for large subnets. If you need to check if an IP address is in the subnet, use Subnet#contains.

  Returns IterableIterator<T>

netmask

• netmask(): bigint

  Get the network mask

  Returns bigint

set

• set(): Set<T>

  A set containing all IP addresses in this subnet

  NOTE: This can be slow for large subnets. If you need to check if an IP address is in the subnet, use Subnet#contains.

  Returns Set<T>

size

• size(): bigint

  Get the number of addresses in this subnet. This number includes the broadcast and gateway addresses, so for the number of usable addresses, subtract 2.

  Returns bigint

toString

• toString(): string

  String representation of this subnet in CIDR notation

  Returns string

  Example

  "203.0.113.0/24"
  Copy

wildcard

• wildcard(): bigint

  Get the network wildcard mask

  Returns bigint

StaticfromCIDR

• fromCIDR(cidr: string): Subnet<IPv4 | IPv6>

  Create subnet from string in CIDR notation

  Parameters

  • cidr: string

  Returns Subnet<IPv4 | IPv6>

  Throws

  RangeError If the address or suffix is invalid