Skip to Content
API Reference@ignitionai/storageSrcClassesClass: DownloadProvider

ignition-monorepo


ignition-monorepo / storage/src / DownloadProvider

Class: DownloadProvider

Defined in: storage/src/providers/download.ts:8 

Browser-only provider that triggers a file download of the model. Write-only: save() works, load() throws.

Implements

Constructors

Constructor

new DownloadProvider(): DownloadProvider

Returns

DownloadProvider

Methods

save()

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

Defined in: storage/src/providers/download.ts:9 

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(): Promise<LayersModel>

Defined in: storage/src/providers/download.ts:34 

Load a previously saved model by its ID.

Returns

Promise<LayersModel>

Implementation of

ModelStorageProvider.load


list()

list(): Promise<ModelInfo[]>

Defined in: storage/src/providers/download.ts:42 

List all models stored by this provider.

Returns

Promise<ModelInfo[]>

Implementation of

ModelStorageProvider.list


delete()

delete(): Promise<void>

Defined in: storage/src/providers/download.ts:47 

Delete a model and its associated files.

Returns

Promise<void>

Implementation of

ModelStorageProvider.delete


exists()

exists(): Promise<boolean>

Defined in: storage/src/providers/download.ts:51 

Return true if a model with the given ID exists.

Returns

Promise<boolean>

Implementation of

ModelStorageProvider.exists

Last updated on