Interface IStore<T>

Store interface that all stores need to implement

Type Parameters

T

Hierarchy

IStore

Index

Properties

close exists init load open reset save

Properties

close

close: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Clean up and close store
  
  Returns Promise<void>

exists

exists: (() => Promise<boolean>)

Type declaration

- (): Promise<boolean>
- Check if store exists and is initialized
  
  Returns Promise<boolean>

init

init: ((data: Partial<AgentData<T>>) => Promise<AgentData<T>>)

Type declaration

- (data: Partial<AgentData<T>>): Promise<AgentData<T>>
- Initilize store with data
  Parameters
  - data: Partial<AgentData<T>>
  Returns Promise<AgentData<T>>

load

load: (() => Promise<AgentData<T>>)

Type declaration

- (): Promise<AgentData<T>>
- Loads data from the store's backend
  
  Returns Promise<AgentData<T>>

open

open: (() => Promise<IStore<T>>)

Type declaration

- (): Promise<IStore<T>>
- Open store
  
  Returns Promise<IStore<T>>

reset

reset: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Clean all the data in the store's backend
  
  Returns Promise<void>

save

save: ((data: AgentData<T>) => Promise<IStore<T>>)

Type declaration

- (data: AgentData<T>): Promise<IStore<T>>
- Persist data to the store's backend
  Parameters
  - data: AgentData<T>
  Returns Promise<IStore<T>>

Generated using TypeDoc