Class KvValueDelta

A KvValueDelta shows how the Data associated with a key in the kvstore has changed.

Implements

Encodable

Index

Constructors

Properties

data? oldData? encodingSchema

Methods

getEncodingSchema toEncodingData fromEncodingData

Constructors

constructor

new KvValueDelta(params): KvValueDelta
Parameters
- params: {
  data?: Uint8Array;
  oldData?: Uint8Array;
  }
  - Optional data?: Uint8Array
  - Optional oldData?: Uint8Array
Returns KvValueDelta
- Defined in types/statedelta.ts:1255

Properties

`Optional` data

data?: Uint8Array

Data stores the most recent value (undefined means deleted)

`Optional` oldData

oldData?: Uint8Array

OldData stores the previous value (undefined means didn't exist)

`Static` `Readonly` encodingSchema

encodingSchema: NamedMapSchema = ...

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 types/statedelta.ts:1261

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 types/statedelta.ts:1265

`Static` fromEncodingData

fromEncodingData(data): KvValueDelta
Parameters
- data: unknown
Returns KvValueDelta
- Defined in types/statedelta.ts:1272

Generated using TypeDoc