Skip to main content

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

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

Interface: CompactType<a>

A runtime representation of a type in Compact

Type parameters​

• a

Methods​

alignment()​

alignment(): Alignment

The field-aligned binary alignment of this type.

Returns​

Alignment

fromValue()​

fromValue(value): a

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​

a

toValue()​

toValue(value): Value

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

Parameters​

• value: a

Returns​

Value

valueAlignment()​

valueAlignment(value): AlignmentAtom[]

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

Parameters​

• value: a

Returns​

AlignmentAtom[]