@proto-kit/sequencer • Docs
Documentation / @proto-kit/sequencer / CachedStateService
Class: CachedStateService
This Interface should be implemented for services that store the state in an external storage (like a DB). This can be used in conjunction with CachedStateService to preload keys for In-Circuit usage.
Extends
Implements
Constructors
new CachedStateService()
new CachedStateService(
parent):CachedStateService
Parameters
• parent: undefined | AsyncStateService
Returns
Overrides
InMemoryStateService.constructor
Defined in
packages/sequencer/src/state/state/CachedStateService.ts:18
Properties
values
values:
Record<string,null|Field[]>
This mapping container null values if the specific entry has been deleted. This is used by the CachedState service to keep track of deletions
Inherited from
Defined in
packages/module/dist/state/InMemoryStateService.d.ts:11
Methods
applyStateTransitions()
applyStateTransitions(
stateTransitions):Promise<void>
Parameters
• stateTransitions: StateTransition<any>[]
Returns
Promise<void>
Defined in
packages/sequencer/src/state/state/CachedStateService.ts:108
commit()
commit():
Promise<void>
Returns
Promise<void>
Implementation of
Defined in
packages/sequencer/src/state/state/CachedStateService.ts:42
get()
get(
key):Promise<undefined|Field[]>
Parameters
• key: Field
Returns
Promise<undefined | Field[]>
Implementation of
Overrides
Defined in
packages/sequencer/src/state/state/CachedStateService.ts:103
getMany()
getMany(
keys):Promise<StateEntry[]>
Parameters
• keys: Field[]
Returns
Promise<StateEntry[]>
Implementation of
Defined in
packages/sequencer/src/state/state/CachedStateService.ts:75
mergeIntoParent()
mergeIntoParent():
Promise<void>
Merges all caches set() operation into the parent and resets this instance to the parent’s state (by clearing the cache and defaulting to the parent)
Returns
Promise<void>
Defined in
packages/sequencer/src/state/state/CachedStateService.ts:127
openTransaction()
openTransaction():
Promise<void>
Returns
Promise<void>
Implementation of
AsyncStateService.openTransaction
Defined in
packages/sequencer/src/state/state/CachedStateService.ts:48
preloadKey()
preloadKey(
key):Promise<void>
Parameters
• key: Field
Returns
Promise<void>
Defined in
packages/sequencer/src/state/state/CachedStateService.ts:52
preloadKeys()
preloadKeys(
keys):Promise<void>
Parameters
• keys: Field[]
Returns
Promise<void>
Defined in
packages/sequencer/src/state/state/CachedStateService.ts:56
set()
set(
key,value):Promise<void>
Parameters
• key: Field
• value: undefined | Field[]
Returns
Promise<void>
Implementation of
Inherited from
Defined in
packages/module/dist/state/InMemoryStateService.d.ts:13
writeStates()
writeStates(
entries):void
Parameters
• entries: StateEntry[]
Returns
void