Skip to main content

CompactTypeUnsignedInteger

@midnight-ntwrk/compact-runtime v0.14.0

@midnight-ntwrk/compact-runtime / CompactTypeUnsignedInteger

Class: CompactTypeUnsignedInteger

Runtime type of the builtin Unsigned Integer types

Implements​

Constructors​

Constructor​

new CompactTypeUnsignedInteger(maxValue, length): CompactTypeUnsignedInteger;

Parameters​

maxValue​

bigint

length​

number

Returns​

CompactTypeUnsignedInteger

Properties​

length​

readonly length: number;

maxValue​

readonly maxValue: bigint;

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