Class Box

Box name and its content.

Hierarchy

Constructors

  • Creates a new Box object.

    Parameters

    • __namedParameters: { name: string | Uint8Array; round: number | bigint; value: string | Uint8Array }
      • name: string | Uint8Array
      • round: number | bigint
      • value: string | Uint8Array

    Returns modelsv2.Box

Properties

attribute_map: Record<string, string>
name: Uint8Array

(name) box name, base64 encoded

round: number | bigint

The round for which this information is relevant

value: Uint8Array

(value) box value, base64 encoded.

Methods

  • Get an object ready for encoding to either JSON or msgpack.

    Parameters

    • binary: boolean = false

      Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON.

    Returns Record<string, any>

Generated using TypeDoc