Skip to main content

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

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

Class: CompactTypeField

Runtime type of the builtin Field type

Implements​

Constructors​

new CompactTypeField()​

new CompactTypeField(): CompactTypeField

Returns​

CompactTypeField

Methods​

alignment()​

alignment(): Alignment

The field-aligned binary alignment of this type.

Returns​

Alignment

Implementation of​

CompactType.alignment

fromValue()​

fromValue(value): bigint

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​

bigint

Implementation of​

CompactType.fromValue

toValue()​

toValue(value): Value

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

Parameters​

• value: bigint

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: bigint

Returns​

AlignmentAtom[]

Implementation of​

CompactType.valueAlignment