Evolution SDK

IPv6.ts

IPv6 overview


Table of contents


arbitrary

arbitrary

FastCheck arbitrary for generating random IPv6 instances.

Signature

export declare const arbitrary: FastCheck.Arbitrary<IPv6>

Added in v2.0.0

encoding

toBytes

Encode IPv6 to bytes.

Signature

export declare const toBytes: (a: IPv6, overrideOptions?: ParseOptions) => Uint8Array

Added in v2.0.0

toHex

Encode IPv6 to hex string.

Signature

export declare const toHex: (a: IPv6, overrideOptions?: ParseOptions) => string

Added in v2.0.0

parsing

fromBytes

Parse IPv6 from bytes.

Signature

export declare const fromBytes: (i: Uint8Array, overrideOptions?: ParseOptions) => IPv6

Added in v2.0.0

fromHex

Parse IPv6 from hex string.

Signature

export declare const fromHex: (i: string, overrideOptions?: ParseOptions) => IPv6

Added in v2.0.0

predicates

isIPv6

Predicate for IPv6 instances

Signature

export declare const isIPv6: (u: unknown, overrideOptions?: ParseOptions | number) => u is IPv6

Added in v2.0.0

schemas

IPv6 (class)

IPv6 model stored as 16 raw bytes (network byte order).

Signature

export declare class IPv6

Added in v2.0.0

toJSON (method)

Signature

toJSON()

toString (method)

Signature

toString(): string

[Inspectable.NodeInspectSymbol] (method)

Signature

[Inspectable.NodeInspectSymbol](): unknown

[Equal.symbol] (method)

Signature

[Equal.symbol](that: unknown): boolean

[Hash.symbol] (method)

Signature

[Hash.symbol](): number

utils

FromBytes

Signature

export declare const FromBytes: Schema.transform<
  Schema.SchemaClass<Uint8Array, Uint8Array, never>,
  Schema.SchemaClass<IPv6, IPv6, never>
>

FromHex

Signature

export declare const FromHex: Schema.transform<
  Schema.filter<Schema.Schema<Uint8Array, string, never>>,
  Schema.transform<Schema.SchemaClass<Uint8Array, Uint8Array, never>, Schema.SchemaClass<IPv6, IPv6, never>>
>