@jupyterlite

***`

@jupyterlite / @jupyterlite/contents / BrowserStorageDrive / IOptions

Interface: IOptions#

Defined in: packages/contents/src/drive.ts:997

The options used to create a BrowserStorageDrive.

Extends#

  • IOptions

Properties#

apiEndpoint?#

optional **apiEndpoint**: string

Defined in: node_modules/@jupyterlab/services/lib/contents/index.d.ts:1022

A REST endpoint for drive requests. If not given, defaults to the Jupyter REST API given by Jupyter Server API.

Inherited from#

Drive.IOptions.apiEndpoint

`***

localforage#

localforage: LocalForage

Defined in: packages/contents/src/drive.ts:1011

The localForage instance to use.

***`

name?#

optional **name**: string

Defined in: node_modules/@jupyterlab/services/lib/contents/index.d.ts:1012

The name for the Drive, which is used in file paths to disambiguate it from other drives.

Inherited from#

Drive.IOptions.name

`***

serverSettings?#

optional serverSettings: ISettings

Defined in: node_modules/@jupyterlab/services/lib/contents/index.d.ts:1016

The server settings for the server.

Inherited from#

Drive.IOptions.serverSettings

***`

storageDrivers?#

optional **storageDrivers**: null | string[]

Defined in: packages/contents/src/drive.ts:1006

The drivers to use for storage.

`***

storageName?#

optional storageName: null | string

Defined in: packages/contents/src/drive.ts:1001

The name of the storage instance on e.g. IndexedDB, localStorage