Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FixableBeetArgsStruct<Args>

Convenience wrapper around FixableBeetStruct which is used for plain JavasScript objects, like are used for option args passed to functions.

Type Parameters

  • Args

Hierarchy

Index

Constructors

Properties

description: string = FixableBeetStruct.description
fields: BeetField<Args, any>[]
TYPE: string = 'FixableBeetStruct'
description: string = 'FixableBeetArgsStruct'

Accessors

  • get type(): string

Methods

  • deserialize(buffer: Buffer, offset?: number): [Args, number]
  • Deserializes an instance of the Class from the provided buffer starting to read at the provided offset.

    Parameters

    • buffer: Buffer
    • offset: number = 0

    Returns [Args, number]

    [instance of Class, offset into buffer after deserialization completed]

  • serialize(instance: Args, byteSize?: number): [Buffer, number]
  • Serializes the provided instance into a new {@link Buffer}

    NOTE: that the instance is traversed and each of its fields accessed twice, once to derive a fixed size BeetStruct and then use it to serialize the instance. Therefore ensure that none of the properties that are part of the struct have side effects, i.e. via Getters.

    Parameters

    • instance: Args

      of the struct to serialize

    • Optional byteSize: number

      allows to override the size fo the created Buffer and defaults to the size of the struct to serialize

    Returns [Buffer, number]

  • toFixedFromData(buf: Buffer, offset: number): BeetStruct<Args, Args>
  • toFixedFromValue(args: Args): BeetStruct<Args, Args>

Generated using TypeDoc