Class FileStorage

File-based storage implementation for simple persistence in single-instance deployments.

Stores each key as a separate JSON file in the configured directory. Not suitable for multi-instance deployments — no locking or concurrency protection.

Example

// Default directory: './bot-state'
const storage = new FileStorage()

// Custom directory
const storage = new FileStorage('./data/state')
bot.useState(storage)

Implements

Storage

Index

Constructors

constructor

Methods

read write delete

Constructors

constructor

new FileStorage(rootDir?: string): FileStorage
Create a new FileStorage instance.
Parameters
- rootDir: string = './bot-state'
  Root directory for state files. Defaults to './bot-state'.
Returns FileStorage
- Defined in packages/botas-core/src/state/file-storage.ts:31

Methods

read

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

write

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

delete

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

Class FileStorage

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FileStorage

Methods

read

Parameters

Returns Promise<Record<string, unknown>>

write

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<void>

Settings

On This Page