@jupyterlite

@jupyterlite / @jupyterlite/services / BrowserStorageDrive / IOptions

Interface: IOptions#

Defined in: packages/services/src/contents/drive.ts:1187

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:1044

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

~~defaultContentProvider?~~#

optional defaultContentProvider: IContentProvider

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

The default content provider.

Deprecated#

since 4.5.1 and will be removed in 5.0

Inherited from#

Drive.IOptions.defaultContentProvider

localforage#

localforage: LocalForage

Defined in: packages/services/src/contents/drive.ts:1201

The localForage instance to use.

name?#

optional name: string

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

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:1038

The server settings for the server.

Inherited from#

Drive.IOptions.serverSettings

storageDrivers?#

optional storageDrivers: string[] | null

Defined in: packages/services/src/contents/drive.ts:1196

The drivers to use for storage.

storageName?#

optional storageName: string | null

Defined in: packages/services/src/contents/drive.ts:1191

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