Summary

Exported Class

API Reference

Exported Class

IPv4Address

Properties

version: "4"

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

_octets: { number }

IPv4 octets in network order.

_int: number

Packed 32-bit integer representation.

IPv4Address.sort

IPv4Address.sort(values: { IPv4Address | string }) → { IPv4Address }

IPv4Address.parse

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

IPv4Address.fromOctets

IPv4 Constructors

IPv4Address.fromOctets(octets: { number }) → IPv4Address

IPv4Address.fromInteger

IPv4Address.fromInteger(val: number) → IPv4Address

IPv4Address.fromBytes

IPv4Address.fromBytes(val: buffer | { number }) → IPv4Address

IPv4Address.fromPacked

IPv4Address.fromPacked(val: buffer | { number }) → IPv4Address

IPv4Address:reverseUri

IPv4Address:reverseUri() → string

IPv4Address:toInteger

IPv4Address:toInteger() → number

IPv4Address:toBytes

IPv4Address:toBytes() → buffer

IPv4Address:toPacked

IPv4Address:toPacked() → buffer

IPv4Address:isPrivate

IPv4Address:isPrivate() → boolean

IPv4Address:ipPublic

IPv4Address:ipPublic() → boolean

IPv4Address:isLoopback

IPv4Address:isLoopback() → boolean

IPv4Address:isMulticast

IPv4Address:isMulticast() → boolean

IPv4Address:isLinkLocal

IPv4Address:isLinkLocal() → boolean

IPv4Address:isUnspecified

IPv4Address:isUnspecified() → boolean

IPv4Address:isReserved

IPv4Address:isReserved() → boolean

IPv4Address:isDocumentation

IPv4Address:isDocumentation() → boolean

IPv4Address:isBenchmarking

IPv4Address:isBenchmarking() → boolean

IPv4Address:isShared

IPv4Address:isShared() → boolean

IPv4Address:isBroadcast

IPv4Address:isBroadcast() → boolean

IPv4Address:isGlobal

IPv4Address:isGlobal() → boolean

IPv4Address:category

TODO: Replace string with a union of all categories

IPv4Address:category() → string

IPv4Address:next

IPv4Address:next() → IPv4Address

IPv4Address:previous

IPv4Address:previous() → IPv4Address

IPv4Address.inNetwork

Implemented in network4.luau (needs IPv4Network) and init.luau (needs IPv6Address). Stubs here so the sealed table type includes these properties before patching.

IPv4Address.inNetwork(_self: IPv4Address, _net: any) → boolean

IPv4Address.toIPv6Mapped

IPv4Address.toIPv6Mapped(_self: IPv4Address) → any

IPv4Address:__string

IPv4Address.__string(self: IPv4Address) → string

IPv4Address:__div

(_a: IPv4Address) / (_b: number) → any

IPv4Address:__eq

(a: IPv4Address) == (b: IPv4Address) → boolean

IPv4Address:__lt

(a: IPv4Address) < (b: IPv4Address) → boolean

IPv4Address:__le

(a: IPv4Address) <= (b: IPv4Address) → boolean

IPv4Address:__tostring

IPv4Address.__tostring(self: IPv4Address) → string