@eryx/ip/network4 Module

Summary

Exported Class

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

Functions

IPv4Address:inNetwork(net: IPv4Network)boolean
(a: IPv4Address.IPv4Address) / (b: number)()

API Reference

Exported Class

IPv4Network

Properties

version: "4"

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

_prefix: number

CIDR prefix length.

_network: number

Packed network address as 32-bit integer.

IPv4Network.smallestContaining

IPv4Network.smallestContaining(a: IPv4Address.IPv4Address, b: IPv4Address.IPv4Address)IPv4Network

IPv4Network.parse

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

IPv4Network.mergeNetworks

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

IPv4Network:networkAddress

IPv4Network:networkAddress()IPv4Address.IPv4Address

IPv4Network:broadcastAddress

IPv4Network:broadcastAddress()IPv4Address.IPv4Address

IPv4Network:netmask

IPv4Network:netmask()IPv4Address.IPv4Address

IPv4Network:hostmask

IPv4Network:hostmask()IPv4Address.IPv4Address

IPv4Network:prefixLength

IPv4Network:prefixLength()number

IPv4Network:firstHost

IPv4Network:firstHost()IPv4Address.IPv4Address

IPv4Network:lastHost

IPv4Network:lastHost()IPv4Address.IPv4Address

IPv4Network:hostCount

IPv4Network:hostCount()number

IPv4Network:contains

IPv4Network:contains(ipAddr: IPv4Address.IPv4Address)boolean

IPv4Network:containsNetwork

IPv4Network:containsNetwork(net: IPv4Network)boolean

IPv4Network:overlaps

IPv4Network:overlaps(net: IPv4Network)boolean

IPv4Network:isSubnetOf

IPv4Network:isSubnetOf(net: IPv4Network)boolean

IPv4Network:isSupernetOf

IPv4Network:isSupernetOf(net: IPv4Network)boolean

IPv4Network:subnets

TODO: An __iter, not an array

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

IPv4Network:supernet

TODO: An __iter, not an array

IPv4Network:supernet(newPrefix: number?)IPv4Network

IPv4Network.toIPv6Mapped

Patched by init.luau (needs IPv6Network). Stub so the property exists in the sealed type.

IPv4Network.toIPv6Mapped(_self: IPv4Network)any

IPv4Network:hosts

TODO: An __iter, not an array

IPv4Network:hosts()(() → IPv4Address.IPv4Address?)

IPv4Network:addresses

TODO: An __iter, not an array

IPv4Network:addresses()(() → IPv4Address.IPv4Address?)

Functions

IPv4Address:inNetwork

Patch IPv4Address methods that require IPv4Network

IPv4Address:inNetwork(net: IPv4Network)boolean

IPv4Address.__div

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