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

***

[@jupyterlite](../../../README.md) / [@jupyterlite/apputils](../README.md) / LiteWorkspaceManager

# Class: LiteWorkspaceManager

Defined in: [packages/apputils/src/workspaces.ts:22](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/workspaces.ts#L22)

A workspace manager for workspaces stored in the browser and on the server.

## Extends

- [`IndexedDBDataConnector`](IndexedDBDataConnector.md)\<`Workspace.IWorkspace`\>

## Constructors

### Constructor

> **new LiteWorkspaceManager**(`options`): `LiteWorkspaceManager`

Defined in: [packages/apputils/src/workspaces.ts:28](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/workspaces.ts#L28)

Construct a new LiteWorkspaceManager.

#### Parameters

##### options

[`IOptions`](../namespaces/LiteWorkspaceManager/interfaces/IOptions.md)

The options for the workspace manager.

#### Returns

`LiteWorkspaceManager`

#### Overrides

[`IndexedDBDataConnector`](IndexedDBDataConnector.md).[`constructor`](IndexedDBDataConnector.md#constructor)

## Properties

### serverSettings

> `readonly` **serverSettings**: `ISettings`

Defined in: [packages/apputils/src/workspaces.ts:37](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/workspaces.ts#L37)

The server settings.

## Accessors

### defaultStorageOptions

#### Get Signature

> **get** `protected` **defaultStorageOptions**(): `LocalForageOptions`

Defined in: [packages/apputils/src/statedb.ts:55](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/statedb.ts#L55)

Get default options for localForage instances

##### Returns

`LocalForageOptions`

#### Inherited from

[`IndexedDBDataConnector`](IndexedDBDataConnector.md).[`defaultStorageOptions`](IndexedDBDataConnector.md#defaultstorageoptions)

***

### storage

#### Get Signature

> **get** `protected` **storage**(): `Promise`\<`LocalForage`\>

Defined in: [packages/apputils/src/statedb.ts:41](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/statedb.ts#L41)

A lazy reference to the underlying storage.

##### Returns

`Promise`\<`LocalForage`\>

#### Inherited from

[`IndexedDBDataConnector`](IndexedDBDataConnector.md).[`storage`](IndexedDBDataConnector.md#storage)

## Methods

### clear()

> **clear**(): `Promise`\<`void`\>

Defined in: [packages/apputils/src/workspaces.ts:107](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/workspaces.ts#L107)

Clear all workspace data

#### Returns

`Promise`\<`void`\>

A promise which resolves when the workspace data is cleared

***

### createStorage()

> `protected` **createStorage**(): `LocalForage`

Defined in: [packages/apputils/src/statedb.ts:69](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/statedb.ts#L69)

Initialize the default storage for contents.

#### Returns

`LocalForage`

#### Inherited from

[`IndexedDBDataConnector`](IndexedDBDataConnector.md).[`createStorage`](IndexedDBDataConnector.md#createstorage)

***

### fetch()

> **fetch**(`id`): `Promise`\<`IWorkspace`\>

Defined in: [packages/apputils/src/workspaces.ts:45](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/workspaces.ts#L45)

Fetch a workspace by id.

#### Parameters

##### id

`string`

The workspace id

#### Returns

`Promise`\<`IWorkspace`\>

A promise that resolves with the workspace.

#### Overrides

[`IndexedDBDataConnector`](IndexedDBDataConnector.md).[`fetch`](IndexedDBDataConnector.md#fetch)

***

### initialize()

> **initialize**(): `Promise`\<`void`\>

Defined in: [packages/apputils/src/statedb.ts:33](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/statedb.ts#L33)

Initialize the data connector.

#### Returns

`Promise`\<`void`\>

#### Inherited from

[`IndexedDBDataConnector`](IndexedDBDataConnector.md).[`initialize`](IndexedDBDataConnector.md#initialize)

***

### initStorage()

> `protected` **initStorage**(): `Promise`\<`void`\>

Defined in: [packages/apputils/src/statedb.ts:48](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/statedb.ts#L48)

Initialize storage instance

#### Returns

`Promise`\<`void`\>

#### Inherited from

[`IndexedDBDataConnector`](IndexedDBDataConnector.md).[`initStorage`](IndexedDBDataConnector.md#initstorage)

***

### list()

> **list**(): `Promise`\<\{ `ids`: `string`[]; `values`: `IWorkspace`[]; \}\>

Defined in: [packages/apputils/src/workspaces.ts:74](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/workspaces.ts#L74)

List all workspaces.

#### Returns

`Promise`\<\{ `ids`: `string`[]; `values`: `IWorkspace`[]; \}\>

A promise that resolves with all workspace ids

#### Overrides

[`IndexedDBDataConnector`](IndexedDBDataConnector.md).[`list`](IndexedDBDataConnector.md#list)

***

### remove()

> **remove**(`id`): `Promise`\<`void`\>

Defined in: [packages/apputils/src/statedb.ts:127](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/statedb.ts#L127)

Remove a value from the data connector.

#### Parameters

##### id

`string`

The identifier of the value to remove.

#### Returns

`Promise`\<`void`\>

A promise that resolves when the value is removed.

#### Inherited from

[`IndexedDBDataConnector`](IndexedDBDataConnector.md).[`remove`](IndexedDBDataConnector.md#remove)

***

### save()

> **save**(`id`, `value`): `Promise`\<`void`\>

Defined in: [packages/apputils/src/statedb.ts:139](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/apputils/src/statedb.ts#L139)

Save a value to the data connector.

#### Parameters

##### id

`string`

The identifier of the value to save.

##### value

`IWorkspace`

The value to save.

#### Returns

`Promise`\<`void`\>

A promise that resolves when the value is saved.

#### Inherited from

[`IndexedDBDataConnector`](IndexedDBDataConnector.md).[`save`](IndexedDBDataConnector.md#save)