@eryx/ip/network6 Module

Summary

Exported Class

version: "6"
_prefix: number
_network: { number }
IPv6Network.parse(source: string, options: utils.ParseOptions?)IPv6Network?
IPv6Network.mergeNetworks(networks: { IPv6Network | string }){ IPv6Network }
IPv6Network:contains(ipAddr: IPv6Address.IPv6Address)boolean
IPv6Network:subnets(newPrefix: number?)(() → IPv6Network?)
IPv6Network:supernet(newPrefix: number?)IPv6Network
IPv6Network:hosts()(() → IPv6Address.IPv6Address?)
IPv6Network:addresses()(() → IPv6Address.IPv6Address?)

Functions

IPv6Address:inNetwork(net: IPv6Network)boolean
(a: IPv6Address.IPv6Address) / (b: number)()

API Reference

Exported Class

IPv6Network

Properties

version: "6"

IP version number (6). This value is a string for type narrowing

_prefix: number

CIDR prefix length.

_network: { number }

Network address as hextets.

IPv6Network.smallestContaining

IPv6Network.smallestContaining(a: IPv6Address.IPv6Address, b: IPv6Address.IPv6Address)IPv6Network

IPv6Network.parse

IPv6Network.parse(source: string, options: utils.ParseOptions?)IPv6Network?

IPv6Network.mergeNetworks

IPv6Network.mergeNetworks(networks: { IPv6Network | string }){ IPv6Network }

IPv6Network:networkAddress

IPv6Network:networkAddress()IPv6Address.IPv6Address

IPv6Network:broadcastAddress

IPv6Network:broadcastAddress()IPv6Address.IPv6Address

IPv6Network:netmask

IPv6Network:netmask()IPv6Address.IPv6Address

IPv6Network:hostmask

IPv6Network:hostmask()IPv6Address.IPv6Address

IPv6Network:prefixLength

IPv6Network:prefixLength()number

IPv6Network:firstHost

IPv6Network:firstHost()IPv6Address.IPv6Address

IPv6Network:lastHost

IPv6Network:lastHost()IPv6Address.IPv6Address

IPv6Network:hostCount

IPv6Network:hostCount()number

IPv6Network:contains

IPv6Network:contains(ipAddr: IPv6Address.IPv6Address)boolean

IPv6Network:containsNetwork

IPv6Network:containsNetwork(net: IPv6Network)boolean

IPv6Network:overlaps

IPv6Network:overlaps(net: IPv6Network)boolean

IPv6Network:isSubnetOf

IPv6Network:isSubnetOf(net: IPv6Network)boolean

IPv6Network:isSupernetOf

IPv6Network:isSupernetOf(net: IPv6Network)boolean

IPv6Network:subnets

TODO: An __iter, not an array

IPv6Network:subnets(newPrefix: number?)(() → IPv6Network?)

IPv6Network:supernet

TODO: An __iter, not an array

IPv6Network:supernet(newPrefix: number?)IPv6Network

IPv6Network:hosts

TODO: An __iter, not an array

IPv6Network:hosts()(() → IPv6Address.IPv6Address?)

IPv6Network:addresses

TODO: An __iter, not an array

IPv6Network:addresses()(() → IPv6Address.IPv6Address?)

Functions

IPv6Address:inNetwork

Patch IPv6Address methods that require IPv6Network

IPv6Address:inNetwork(net: IPv6Network)boolean

IPv6Address.__div

(a: IPv6Address.IPv6Address) / (b: number)()