Class Box

Box name and its content.

Implements

Encodable

Index

Constructors

Properties

name round value encodingSchemaValue

Accessors

Methods

getEncodingSchema toEncodingData fromEncodingData

Constructors

constructor

new Box(__namedParameters): indexerModels.Box
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 indexerModels.Box
- Defined in client/v2/indexer/models/types.ts:3822

Properties

name

name: Uint8Array

(name) box name, base64 encoded

round

round: bigint

The round for which this information is relevant

value

value: Uint8Array

(value) box value, base64 encoded.

`Static` `Private` encodingSchemaValue

encodingSchemaValue: undefined | Schema

Accessors

`Static` encodingSchema

get encodingSchema(): Schema
Returns Schema
- Defined in client/v2/indexer/models/types.ts:3789

Methods

getEncodingSchema

getEncodingSchema(): Schema
Get the encoding Schema for this object, used to prepare the encoding data for msgpack and JSON.

Returns Schema
Implementation of Encodable.getEncodingSchema
- Defined in client/v2/indexer/models/types.ts:3837

toEncodingData

toEncodingData(): Map<string, unknown>
Extract the encoding data for this object. This data, after being prepared by the encoding Schema, can be encoded to msgpack or JSON.

Returns Map<string, unknown>
Implementation of Encodable.toEncodingData
- Defined in client/v2/indexer/models/types.ts:3841

`Static` fromEncodingData

fromEncodingData(data): indexerModels.Box
Parameters
- data: unknown
Returns indexerModels.Box
- Defined in client/v2/indexer/models/types.ts:3849

Generated using TypeDoc