Skip to main content

@midnight-ntwrk/compact-runtime v0.6.13Readme | API


@midnight-ntwrk/compact-runtime v0.6.13 / CompactTypeOpaqueString

Class: CompactTypeOpaqueString

Runtime type of Opaque["string"]

Implements

Constructors

new CompactTypeOpaqueString()

new CompactTypeOpaqueString(): CompactTypeOpaqueString

Returns

CompactTypeOpaqueString

Methods

alignment()

alignment(): Alignment

The field-aligned binary alignment of this type.

Returns

Alignment

Implementation of

CompactType.alignment


fromValue()

fromValue(value): string

Converts this type's field-aligned binary representation to its TypeScript representation destructively; (partially) consuming the input, and ignoring superflous data for chaining.

Parameters

value: Value

Returns

string

Implementation of

CompactType.fromValue


toValue()

toValue(value): Value

Converts this type's TypeScript representation to its field-aligned binary representation

Parameters

value: string

Returns

Value

Implementation of

CompactType.toValue


valueAlignment()

valueAlignment(value): AlignmentAtom[]

Retrieves the "instantiated" alignment of a value of this type's TypeScript representation

Parameters

value: string

Returns

AlignmentAtom[]

Implementation of

CompactType.valueAlignment