Evolution SDK

MultiHostName.ts

MultiHostName overview


Table of contents


encoding

toCBORBytes

Encode MultiHostName to CBOR bytes.

Signature

export declare const toCBORBytes: (data: MultiHostName, options?: CBOR.CodecOptions) => any

Added in v2.0.0

toCBORHex

Encode MultiHostName to CBOR hex string.

Signature

export declare const toCBORHex: (data: MultiHostName, options?: CBOR.CodecOptions) => string

Added in v2.0.0

model

MultiHostName (class)

Schema for MultiHostName representing a multiple host name record. multi_host_name = (2, dns_name)

Signature

export declare class MultiHostName

Added in v2.0.0

toJSON (method)

Convert to JSON-serializable format.

Signature

toJSON()

Added in v2.0.0

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

toCBORBytes (method)

Convert to CBOR bytes.

Signature

toCBORBytes(): Uint8Array

Added in v2.0.0

toCBORHex (method)

Convert to CBOR hex string.

Signature

toCBORHex(): string

Added in v2.0.0

parsing

fromCBORBytes

Parse MultiHostName from CBOR bytes.

Signature

export declare const fromCBORBytes: (bytes: Uint8Array, options?: CBOR.CodecOptions) => MultiHostName

Added in v2.0.0

fromCBORHex

Parse MultiHostName from CBOR hex string.

Signature

export declare const fromCBORHex: (hex: string, options?: CBOR.CodecOptions) => MultiHostName

Added in v2.0.0

schemas

FromCBORBytes

CBOR bytes transformation schema for MultiHostName.

Signature

export declare const FromCBORBytes: (
  options?: CBOR.CodecOptions
) => Schema.transform<
  Schema.transformOrFail<
    typeof Schema.Uint8ArrayFromSelf,
    Schema.declare<CBOR.CBOR, CBOR.CBOR, readonly [], never>,
    never
  >,
  Schema.transformOrFail<
    Schema.Tuple2<Schema.Literal<[2n]>, typeof Schema.String>,
    Schema.SchemaClass<MultiHostName, MultiHostName, never>,
    never
  >
>

Added in v2.0.0

FromCBORHex

CBOR hex transformation schema for MultiHostName.

Signature

export declare const FromCBORHex: (
  options?: CBOR.CodecOptions
) => Schema.transform<
  Schema.Schema<Uint8Array, string, never>,
  Schema.transform<
    Schema.transformOrFail<
      typeof Schema.Uint8ArrayFromSelf,
      Schema.declare<CBOR.CBOR, CBOR.CBOR, readonly [], never>,
      never
    >,
    Schema.transformOrFail<
      Schema.Tuple2<Schema.Literal<[2n]>, typeof Schema.String>,
      Schema.SchemaClass<MultiHostName, MultiHostName, never>,
      never
    >
  >
>

Added in v2.0.0

FromCDDL

CDDL schema for MultiHostName. multi_host_name = (2, dns_name)

Signature

export declare const FromCDDL: Schema.transformOrFail<
  Schema.Tuple2<Schema.Literal<[2n]>, typeof Schema.String>,
  Schema.SchemaClass<MultiHostName, MultiHostName, never>,
  never
>

Added in v2.0.0

testing

arbitrary

FastCheck arbitrary for MultiHostName instances.

Signature

export declare const arbitrary: FastCheck.Arbitrary<MultiHostName>

Added in v2.0.0