***`
@jupyterlite / @jupyterlite/apputils / LiteWorkspaceManager
Class: LiteWorkspaceManager#
Defined in: packages/apputils/src/workspaces.ts:22
A workspace manager for workspaces stored in the browser and on the server.
Extends#
IndexedDBDataConnector<Workspace.IWorkspace>
Constructors#
Constructor#
**new LiteWorkspaceManager**(options):LiteWorkspaceManager
Defined in: packages/apputils/src/workspaces.ts:28
Construct a new LiteWorkspaceManager.
Parameters#
options#
The options for the workspace manager.
Returns#
LiteWorkspaceManager
Overrides#
Properties#
serverSettings#
readonly**serverSettings**:ISettings
Defined in: packages/apputils/src/workspaces.ts:37
The server settings.
Accessors#
defaultStorageOptions#
Get Signature#
**get**protected**defaultStorageOptions**():LocalForageOptions
Defined in: packages/apputils/src/statedb.ts:55
Get default options for localForage instances
Returns#
LocalForageOptions
Inherited from#
IndexedDBDataConnector.defaultStorageOptions
`***
storage#
Get Signature#
getprotectedstorage():Promise<LocalForage>
Defined in: packages/apputils/src/statedb.ts:41
A lazy reference to the underlying storage.
Returns#
Promise<LocalForage>
Inherited from#
Methods#
clear()#
clear():Promise<void>
Defined in: packages/apputils/src/workspaces.ts:107
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
Initialize the default storage for contents.
Returns#
LocalForage
Inherited from#
IndexedDBDataConnector.createStorage
`***
fetch()#
fetch(id):Promise<IWorkspace>
Defined in: packages/apputils/src/workspaces.ts:45
Fetch a workspace by id.
Parameters#
id#
string
The workspace id
Returns#
Promise<IWorkspace>
A promise that resolves with the workspace.
Overrides#
***`
initialize()#
**initialize**():Promise<void>
Defined in: packages/apputils/src/statedb.ts:33
Initialize the data connector.
Returns#
Promise<void>
Inherited from#
IndexedDBDataConnector.initialize
`***
initStorage()#
protectedinitStorage():Promise<void>
Defined in: packages/apputils/src/statedb.ts:48
Initialize storage instance
Returns#
Promise<void>
Inherited from#
IndexedDBDataConnector.initStorage
***`
list()#
**list**():Promise<{ids:string[];values:IWorkspace[]; }>
Defined in: packages/apputils/src/workspaces.ts:74
List all workspaces.
Returns#
Promise<{ ids: string[]; values: IWorkspace[]; }>
A promise that resolves with all workspace ids
Overrides#
`***
remove()#
remove(id):Promise<void>
Defined in: packages/apputils/src/statedb.ts:127
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#
***`
save()#
**save**(id,value):Promise\<void`>
Defined in: packages/apputils/src/statedb.ts:139
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.