Interface Storage

Storage provider for reading/writing bot state.

interface Storage {
    read(keys: string[]): Promise<Record<string, unknown>>;
    write(changes: Record<string, unknown>): Promise<void>;
    delete(keys: string[]): Promise<void>;
}

Implemented by

Index

Methods

read write delete

Methods

read

read(keys: string[]): Promise<Record<string, unknown>>
Read items from storage.
Parameters
- keys: string[]
  Keys to read.
Returns Promise<Record<string, unknown>>
Dictionary of key-value pairs that exist in storage.
- Defined in packages/botas-core/src/state/storage.ts:13

write

write(changes: Record<string, unknown>): Promise<void>
Write items to storage.
Parameters
- changes: Record<string, unknown>
  Dictionary of key-value pairs to write.
Returns Promise<void>
- Defined in packages/botas-core/src/state/storage.ts:19

delete

delete(keys: string[]): Promise<void>
Delete items from storage.
Parameters
- keys: string[]
  Keys to delete.
Returns Promise<void>
- Defined in packages/botas-core/src/state/storage.ts:25