Skip to Content
API Reference@ignitionai/storageSrcClassesClass: LocalStorageProvider

ignition-monorepo


ignition-monorepo / storage/src / LocalStorageProvider

Class: LocalStorageProvider

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

Browser-only provider that persists TF.js models in localStorage. Good for small configs & metadata. Models > 5MB will fail.

Implements

Constructors

Constructor

new LocalStorageProvider(): LocalStorageProvider

Returns

LocalStorageProvider

Methods

save()

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

Defined in: storage/src/providers/localstorage.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/localstorage.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/localstorage.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/localstorage.ts:60 

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/localstorage.ts:77 

Return true if a model with the given ID exists.

Parameters

modelId

string

Returns

Promise<boolean>

Implementation of

ModelStorageProvider.exists

Last updated on