Summary

Exported Class

API Reference

Exported Class

IPv6Address

Properties

version: "6"

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

_hextets: { number }

IPv6 hextets in network order.

IPv6Address.sort

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

IPv6Address.parse

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

IPv6Address.fromBytes

IPv6 Constructors

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

IPv6Address.fromPacked

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

IPv6Address.fromInteger

IPv6Address.fromInteger(val: number | string) → IPv6Address

IPv6Address:compressed

IPv6Address:compressed() → string

IPv6Address:expanded

IPv6Address:expanded() → string

IPv6Address:toUriHost

IPv6Address:toUriHost() → string

IPv6Address:reverseUri

IPv6Address:reverseUri() → string

IPv6Address:toBytes

IPv6Address:toBytes() → buffer

IPv6Address:toPacked

IPv6Address:toPacked() → buffer

IPv6Address:toInteger

IPv6Address:toInteger() → string

IPv6Address:isPrivate

IPv6Address:isPrivate() → boolean

IPv6Address:ipPublic

IPv6Address:ipPublic() → boolean

IPv6Address:isLoopback

IPv6Address:isLoopback() → boolean

IPv6Address:isMulticast

IPv6Address:isMulticast() → boolean

IPv6Address:isLinkLocal

IPv6Address:isLinkLocal() → boolean

IPv6Address:isUnspecified

IPv6Address:isUnspecified() → boolean

IPv6Address:isReserved

IPv6Address:isReserved() → boolean

IPv6Address:isDocumentation

IPv6Address:isDocumentation() → boolean

IPv6Address:isBenchmarking

IPv6Address:isBenchmarking() → boolean

IPv6Address:isShared

IPv6Address:isShared() → boolean

IPv6Address:isGlobal

IPv6Address:isGlobal() → boolean

IPv6Address:category

TODO: Replace string with a union of all categories

IPv6Address:category() → string

IPv6Address:isUniqueLocal

IPv6Address:isUniqueLocal() → boolean

IPv6Address:isIPv4Mapped

IPv6Address:isIPv4Mapped() → boolean

IPv6Address:isIPv4Compatible

IPv6Address:isIPv4Compatible() → boolean

IPv6Address:scope

TODO: Expand return enum

IPv6Address:scope() → "interface-local" | "link-local" | "global"

IPv6Address:is6to4

IPv6Address:is6to4() → boolean

IPv6Address:isTeredo

IPv6Address:isTeredo() → boolean

IPv6Address:next

IPv6Address:next() → IPv6Address

IPv6Address:previous

IPv6Address:previous() → IPv6Address

IPv6Address.inNetwork

Implemented in network6.luau (needs IPv6Network) and init.luau (needs IPv4Address). Stubs here so the sealed table type includes these properties before patching.

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

IPv6Address.getEmbeddedIPv4

IPv6Address.getEmbeddedIPv4(_self: IPv6Address) → any

IPv6Address.toIPv4

IPv6Address.toIPv4(_self: IPv6Address) → any

IPv6Address:__string

IPv6Address.__string(self: IPv6Address) → string

IPv6Address:__div

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

IPv6Address:__eq

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

IPv6Address:__lt

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

IPv6Address:__le

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

IPv6Address:__tostring

IPv6Address.__tostring(self: IPv6Address) → string