Class Shape<I, O>Abstract

Type Parameters

  • in I
  • out O = I

Hierarchy

  • _Shape
    • Shape

Implements

Constructors

constructor

Properties

decoders encoders metadata nativeType? registerDecoder registerEncoder staticSize subAssert subDecode subEncode tryDecode tryEncode

Methods

assert decode encode encodeAsync

Constructors

constructor

  • new Shape<in I, out O>(): $.Shape<I, O>

  • Type Parameters

    • in I
    • out O = I

    Returns $.Shape<I, O>

Properties

decoders

decoders: [$.Predicate<any>, $.Decoder<$.Shape<any, any>, any, any>][]

encoders

encoders: [$.Predicate<any>, $.Encoder<$.Shape<any, any>, any>][]

Abstractmetadata

metadata: $.Metadata<I, O>

An array with metadata representing the construction of this shape

OptionalnativeType

nativeType?: string

registerDecoder

registerDecoder: ((predicate: $.Predicate<any>, decoder: $.Decoder<$.Shape<any, any>, any, any>) => void)

registerEncoder

registerEncoder: ((predicate: $.Predicate<any>, encoder: $.Encoder<$.Shape<any, any>, any>) => void)

AbstractstaticSize

staticSize: number

A static estimation of the size, which may be an under- or over-estimate

AbstractsubAssert

subAssert: ((state: $.AssertState) => void)

Asserts that the value is valid for this shape

AbstractsubDecode

subDecode: ((buffer: $.DecodeBuffer) => O)

Decodes the value from the supplied buffer

AbstractsubEncode

subEncode: ((buffer: $.EncodeBuffer, value: I) => void)

Encodes the value into the supplied buffer, which should have at least staticSize free byte.

tryDecode

tryDecode: ((input: any) => O)

tryEncode

tryEncode: ((input: any) => Uint8Array)

Methods

assert

  • assert(value): asserts value is I

  • Requires the shape to have an explicit type annotation; if it doesn't, use $.assert instead.

    Parameters

    • value: unknown

    Returns asserts value is I

decode

  • decode(array): O

  • Decodes a value from the supplied Uint8Array

    Parameters

    • array: Uint8Array

    Returns O

encode

  • encode(value): Uint8Array

  • Encodes the value into a new Uint8Array (throws if async)

    Parameters

    • value: I

    Returns Uint8Array

encodeAsync

  • encodeAsync(value): Promise<Uint8Array>

  • Asynchronously encodes the value into a new Uint8Array

    Parameters

    • value: I

    Returns Promise<Uint8Array>

On This Page

Constructors
Properties
Methods