Class BoxDescriptor

constructor

• new BoxDescriptor(name): indexerModels.BoxDescriptor

• Creates a new BoxDescriptor object.

  Parameters

  • name: {
        name: string | Uint8Array;
    }

    Base64 encoded box name

    • name: string | Uint8Array

  Returns indexerModels.BoxDescriptor

name

Static encodingSchema

• get encodingSchema(): Schema

• Returns Schema

getEncodingSchema

• getEncodingSchema(): Schema

• Get the encoding Schema for this object, used to prepare the encoding data for msgpack and JSON.

  Returns Schema

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>

Static fromEncodingData

• fromEncodingData(data): indexerModels.BoxDescriptor

• Parameters

  • data: unknown

  Returns indexerModels.BoxDescriptor