[**@jupyterlite**](../../../../../README.md)

***

[@jupyterlite](../../../../../README.md) / [@jupyterlite/services](../../../README.md) / [BrowserStorageDrive](../README.md) / IOptions

# Interface: IOptions

Defined in: [packages/services/src/contents/drive.ts:1043](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drive.ts#L1043)

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

A REST endpoint for drive requests.
If not given, defaults to the Jupyter
REST API given by [Jupyter Server API](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter-server/jupyter_server/main/jupyter_server/services/api/api.yaml#!/contents).

#### Inherited from

`Drive.IOptions.apiEndpoint`

***

### ~~defaultContentProvider?~~

> `optional` **defaultContentProvider**: `IContentProvider`

Defined in: node\_modules/@jupyterlab/services/lib/contents/index.d.ts:1029

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:1057](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drive.ts#L1057)

The localForage instance to use.

***

### name?

> `optional` **name**: `string`

Defined in: node\_modules/@jupyterlab/services/lib/contents/index.d.ts:1013

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

The server settings for the server.

#### Inherited from

`Drive.IOptions.serverSettings`

***

### storageDrivers?

> `optional` **storageDrivers**: `null` \| `string`[]

Defined in: [packages/services/src/contents/drive.ts:1052](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drive.ts#L1052)

The drivers to use for storage.

***

### storageName?

> `optional` **storageName**: `null` \| `string`

Defined in: [packages/services/src/contents/drive.ts:1047](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/services/src/contents/drive.ts#L1047)

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