Skip to Content
API Reference@ignitionai/storageSrcClassesClass: IndexedDBProvider

ignition-monorepo


ignition-monorepo / storage/src / IndexedDBProvider

Class: IndexedDBProvider

Defined in: storage/src/providers/indexeddb.ts:10 

Browser-only provider that persists TF.js models in IndexedDB. Best for models > 5MB (localStorage quota).

Implements

Constructors

Constructor

new IndexedDBProvider(): IndexedDBProvider

Returns

IndexedDBProvider

Methods

save()

save(modelId, model, metadata?): Promise<string>

Defined in: storage/src/providers/indexeddb.ts:11 

Serialize and persist a model. Returns the URI where it was stored.

Parameters

modelId

string

model

LayersModel

metadata?

Record<string, unknown>

Returns

Promise<string>

Implementation of

ModelStorageProvider.save


load()

load(modelId): Promise<LayersModel>

Defined in: storage/src/providers/indexeddb.ts:30 

Load a previously saved model by its ID.

Parameters

modelId

string

Returns

Promise<LayersModel>

Implementation of

ModelStorageProvider.load


list()

list(): Promise<ModelInfo[]>

Defined in: storage/src/providers/indexeddb.ts:38 

List all models stored by this provider.

Returns

Promise<ModelInfo[]>

Implementation of

ModelStorageProvider.list


delete()

delete(modelId): Promise<void>

Defined in: storage/src/providers/indexeddb.ts:62 

Delete a model and its associated files.

Parameters

modelId

string

Returns

Promise<void>

Implementation of

ModelStorageProvider.delete


exists()

exists(modelId): Promise<boolean>

Defined in: storage/src/providers/indexeddb.ts:69 

Return true if a model with the given ID exists.

Parameters

modelId

string

Returns

Promise<boolean>

Implementation of

ModelStorageProvider.exists

Last updated on