Class Subnet<Type>

constructor

• new Subnet<Type>(subnet, type?): Subnet<Type>

• Create a new Subnet

  Type Parameters

  • Type extends 4 | 6 = 4 | 6

  Parameters

  • subnet: string | Subnet<4 | 6>
  • Optional type: Type

  Returns Subnet<Type>

  Example

  import { network } from "@rjweb/utils"
  
  const subnet = new network.Subnet('127.0.0.1/24')
  subnet.isIPv4() // true
  
  subnet.size() // 255n
  subnet.first() // <IPAddress v4 127.0.0.0>
  subnet.last() // <IPAddress v4 127.0.0.255>
  
  for (const ip of subnet) {
    console.log(ip.long())
  }
  Copy

  Since

  1.7.0

  Supports

  nodejs, browser

netmask

subnetmask

[iterator]

• [iterator](): Iterator<IPAddress<Type>, any, any>

• Returns Iterator<IPAddress<Type>, any, any>

first

• first(): IPAddress<Type>

• Get the first IP of the Subnet

  Returns IPAddress<Type>

  Since

  1.7.0

includes

• includes(...ips): boolean

• Check if the Subnet includes another IP address or subnet

  Parameters

  • Rest ...ips: (Subnet<Type> | IPAddress<Type>)[]

  Returns boolean

  Since

  1.11.0

isIPv4

• isIPv4(): this is Subnet<4>

• Whether this is an IPv4 Subnet

  Returns this is Subnet<4>

  Since

  1.7.0

isIPv6

• isIPv6(): this is Subnet<6>

• Whether this is an IPv6 Subnet

  Returns this is Subnet<6>

  Since

  1.7.0

last

• last(): IPAddress<Type>

• Get the last IP of the Subnet

  Returns IPAddress<Type>

  Since

  1.7.0

size

• size(): bigint

• Get the Size of the Subnet

  Returns bigint

  Since

  1.7.0