Skip to main content

Class: FileStorage

Defined in: packages/core/src/history/storage.ts:120

Persists history as a JSON file through the platform's filesystem capability, loading the full platform adapter first (initPlatformAdapter); throws on a platform without one (browsers, React Native).

Example​

const history = new History(new FileStorage('./chat-history.json'));

Implements​

Constructors​

Constructor​

new FileStorage(filepath, options?): FileStorage

Defined in: packages/core/src/history/storage.ts:125

Parameters​

filepath​

string

options?​
autoSave?​

boolean

Returns​

FileStorage

Methods​

load()​

load(): Promise<StorageData | null>

Defined in: packages/core/src/history/storage.ts:130

null or undefined when nothing is stored. Anything that is not a stored history makes History's load reject, so it is never saved over.

Returns​

Promise<StorageData | null>

Implementation of​

HistoryStorage.load


save()​

save(data): Promise<void>

Defined in: packages/core/src/history/storage.ts:156

History always saves StoredHistoryV2.

Parameters​

data​

StorageData

Returns​

Promise<void>

Implementation of​

HistoryStorage.save