Interface SubStore

Hierarchy

ImmutableSubStore
- SubStore

Index

Methods

createSnapshot del get getWithSchema has iterate iterateWithSchema restoreSnapshot set setWithSchema

Methods

createSnapshot

createSnapshot(): number
Returns number
- Defined in framework/src/state_machine/types.ts:34

del

del(key: Buffer): Promise<void>
Parameters
- key: Buffer
Returns Promise<void>
- Defined in framework/src/state_machine/types.ts:30

get

get(key: Buffer): Promise<Buffer>
Parameters
- key: Buffer
Returns Promise<Buffer>
Inherited from ImmutableSubStore.get
- Defined in framework/src/state_machine/types.ts:22

getWithSchema

getWithSchema<T>(key: Buffer, schema: Schema): Promise<T>
Type Parameters
- T
Parameters
- key: Buffer
- schema: Schema
Returns Promise<T>
Inherited from ImmutableSubStore.getWithSchema
- Defined in framework/src/state_machine/types.ts:23

has

has(key: Buffer): Promise<boolean>
Parameters
- key: Buffer
Returns Promise<boolean>
Inherited from ImmutableSubStore.has
- Defined in framework/src/state_machine/types.ts:24

iterate

iterate(input: IterateOptions): Promise<{
key: Buffer;
value: Buffer;
}[]>
Parameters
- input: IterateOptions
Returns Promise<{
key: Buffer;
value: Buffer;
}[]>
Inherited from ImmutableSubStore.iterate
- Defined in framework/src/state_machine/types.ts:25

iterateWithSchema

iterateWithSchema<T>(input: IterateOptions, schema: Schema): Promise<{
key: Buffer;
value: T;
}[]>
Type Parameters
- T
Parameters
- input: IterateOptions
- schema: Schema
Returns Promise<{
key: Buffer;
value: T;
}[]>
Inherited from ImmutableSubStore.iterateWithSchema
- Defined in framework/src/state_machine/types.ts:26

restoreSnapshot

restoreSnapshot(snapshotID: number): void
Parameters
- snapshotID: number
Returns void
- Defined in framework/src/state_machine/types.ts:35

set

set(key: Buffer, value: Buffer): Promise<void>
Parameters
- key: Buffer
- value: Buffer
Returns Promise<void>
- Defined in framework/src/state_machine/types.ts:31

setWithSchema

setWithSchema(key: Buffer, value: object, schema: Schema): Promise<void>
Parameters
- key: Buffer
- value: object
- schema: Schema
Returns Promise<void>
- Defined in framework/src/state_machine/types.ts:33

Generated using TypeDoc