Class IpAddress

constructor

• new IpAddress(address: number | Uint8Array | IpAddress): IpAddress

  从 IPv4 网络序整数、16 字节 IPv6 数据或现有地址副本创建。

  Parameters

  • address: number | Uint8Array | IpAddress

  Returns IpAddress
• new IpAddress(a: number, b: number, c: number, d: number): IpAddress

  从四个 0～255 的十进制八位组创建 IPv4 地址。

  Parameters

  • a: number
  • b: number
  • c: number
  • d: number

  Returns IpAddress

Static ReadonlyAny

Static ReadonlyAnyV4

Static ReadonlyAnyV6

Static ReadonlyBroadcast

Static ReadonlyBroadcastV4

Static ReadonlyLocalHost

Static ReadonlyLocalHostV4

Static ReadonlyLocalHostV6

Static ReadonlyType

compare

• compare(other: IpAddress): number

  按地址族、地址字节排序比较，返回负数、零或正数。

  Parameters

  • other: IpAddress

  Returns number

getType

• getType(): IpAddressType

  返回地址族。

  Returns IpAddressType

isV4

• isV4(): boolean

  返回是否为 IPv4 地址。

  Returns boolean

isV6

• isV6(): boolean

  返回是否为 IPv6 地址。

  Returns boolean

toBytes

• toBytes(): Uint8Array

  返回 IPv6 的 16 字节副本；IPv4 地址抛出 TypeError。

  Returns Uint8Array

toInteger

• toInteger(): number

  返回 IPv4 网络序无符号 32 位整数；IPv6 地址抛出 TypeError。

  Returns number

toString

• toString(): string

  返回 IPv4 点分十进制或压缩 IPv6 文本表示。

  Returns string

StaticfromString

• fromString(address: string): undefined | IpAddress

  解析 IP 字面量；不解析域名、不接受 IPv6 区域标识，格式错误返回 undefined。

  Parameters

  • address: string

  Returns undefined | IpAddress

StaticgetLocalAddress

• getLocalAddress(type?: IpAddressType): Promise<undefined | IpAddress>

  按系统路由查询指定地址族的本地出口地址，失败返回 undefined。

  Parameters

  • type: IpAddressType = IpAddressType.IpV4

  Returns Promise<undefined | IpAddress>

StaticgetPublicAddress

• getPublicAddress(
      timeout?: ReadonlyValue,
      type?: undefined | IpAddressType,
      secure?: boolean,
  ): Promise<undefined | IpAddress>

  通过外部 DNS/HTTP 服务异步查询公网地址；secure 使用 HTTPS，失败返回 undefined。

  Parameters

  • timeout: ReadonlyValue = Time.Zero
  • type: undefined | IpAddressType = IpAddressType.IpV4
  • secure: boolean = false

  Returns Promise<undefined | IpAddress>

Staticresolve

• resolve(hostname: string): Promise<undefined | IpAddress>

  异步解析主机名为首个 IPv4 地址；IP 字面量直接返回，失败为 undefined。

  Parameters

  • hostname: string

  Returns Promise<undefined | IpAddress>