@eryx/ip Module

Summary

Functions

addr4:toIPv6Mapped() → addr6.IPv6Address
net4:toIPv6Mapped() → net6.IPv6Network
addr6:getEmbeddedIPv4() → addr4.IPv4Address?
addr6:toIPv4() → addr4.IPv4Address?
ip.address(source: string, options: ParseOptions?) → (addr4.IPv4Address | addr6.IPv6Address)?
ip.network(source: string, options: ParseOptions?) → (net4.IPv4Network | net6.IPv6Network)?
ip.interface(source: string, options: ParseOptions?) → (iface4.IPv4Interface | iface6.IPv6Interface)?
ip.parse(source: string, options: ParseOptions?) → (addr4.IPv4Address | addr6.IPv6Address | net4.IPv4Network | net6.IPv6Network)?
ip.isAddress(source: string) → boolean
ip.isNetwork(source: string) → boolean
ip.isIPv4(source: string) → boolean
ip.isIPv6(source: string) → boolean
ip.smallestEnclosingIPv4Network(a: addr4.IPv4Address, b: addr4.IPv4Address) → net4.IPv4Network
ip.smallestEnclosingIPv6Network(a: addr6.IPv6Address, b: addr6.IPv6Address) → net6.IPv6Network
ip.sortIPv4(values: { addr4.IPv4Address | string }) → { addr4.IPv4Address }
ip.sortIPv6(values: { addr6.IPv6Address | string }) → { addr6.IPv6Address }

API Reference

Functions

addr4:toIPv6Mapped
addr4:toIPv6Mapped() → addr6.IPv6Address

net4:toIPv6Mapped
net4:toIPv6Mapped() → net6.IPv6Network

addr6:getEmbeddedIPv4
addr6:getEmbeddedIPv4() → addr4.IPv4Address?

addr6:toIPv4
addr6:toIPv4() → addr4.IPv4Address?

ip.address
ip.address(source: string, options: ParseOptions?) → (addr4.IPv4Address | addr6.IPv6Address)?

ip.network
ip.network(source: string, options: ParseOptions?) → (net4.IPv4Network | net6.IPv6Network)?

ip.interface
ip.interface(source: string, options: ParseOptions?) → (iface4.IPv4Interface | iface6.IPv6Interface)?

ip.parse
ip.parse(source: string, options: ParseOptions?) → (addr4.IPv4Address | addr6.IPv6Address | net4.IPv4Network | net6.IPv6Network)?

ip.isAddress
ip.isAddress(source: string) → boolean

ip.isNetwork
ip.isNetwork(source: string) → boolean

ip.isIPv4
ip.isIPv4(source: string) → boolean

ip.isIPv6
ip.isIPv6(source: string) → boolean

ip.smallestEnclosingIPv4Network
ip.smallestEnclosingIPv4Network(a: addr4.IPv4Address, b: addr4.IPv4Address) → net4.IPv4Network

ip.smallestEnclosingIPv6Network
ip.smallestEnclosingIPv6Network(a: addr6.IPv6Address, b: addr6.IPv6Address) → net6.IPv6Network

ip.sortIPv4
ip.sortIPv4(values: { addr4.IPv4Address | string }) → { addr4.IPv4Address }

ip.sortIPv6
ip.sortIPv6(values: { addr6.IPv6Address | string }) → { addr6.IPv6Address }

Types

IPv4Address
type IPv4Address = addr4.IPv4Address
Implements: addr4.IPv4Address

IPv6Address
type IPv6Address = addr6.IPv6Address
Implements: addr6.IPv6Address

IPv4Network
type IPv4Network = net4.IPv4Network
Implements: net4.IPv4Network

IPv6Network
type IPv6Network = net6.IPv6Network
Implements: net6.IPv6Network

IPv4Interface
type IPv4Interface = iface4.IPv4Interface
Implements: iface4.IPv4Interface

IPv6Interface
type IPv6Interface = iface6.IPv6Interface
Implements: iface6.IPv6Interface

IPv4Range
type IPv4Range = range4.IPv4Range
Implements: range4.IPv4Range

IPv6Range
type IPv6Range = range6.IPv6Range
Implements: range6.IPv6Range

ParseOptions
type ParseOptions = utils.ParseOptions
Implements: utils.ParseOptions