Evolution SDK

IPv4.ts

IPv4 overview


Table of contents


arbitrary

arbitrary

FastCheck arbitrary for generating random IPv4 instances.

Signature

export declare const arbitrary: FastCheck.Arbitrary<IPv4>

Added in v2.0.0

encoding

toBytes

Encode IPv4 to bytes.

Signature

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

Added in v2.0.0

toHex

Encode IPv4 to hex string.

Signature

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

Added in v2.0.0

parsing

fromBytes

Parse IPv4 from bytes.

Signature

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

Added in v2.0.0

fromHex

Parse IPv4 from hex string.

Signature

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

Added in v2.0.0

predicates

isIPv4

Predicate for IPv4 instances

Signature

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

Added in v2.0.0

schemas

IPv4 (class)

IPv4 model stored as 4 raw bytes (network byte order).

Signature

export declare class IPv4

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<IPv4, IPv4, 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<IPv4, IPv4, never>>
>