@jupyterlite

***`

@jupyterlite / @jupyterlite/server / ServiceWorkerManager

Class: ServiceWorkerManager#

Defined in: service-worker-manager.ts:36

A class that manages the ServiceWorker registration and communication, used for accessing the file system.

Implements#

Constructors#

Constructor#

**new ServiceWorkerManager**(options): ServiceWorkerManager

Defined in: service-worker-manager.ts:40

Construct a new ServiceWorkerManager.

Parameters#

options#

IOptions

Returns#

ServiceWorkerManager

Accessors#

browsingContextId#

Get Signature#

**get** **browsingContextId**(): string

Defined in: service-worker-manager.ts:80

A unique id to identify the browsing context where the ServiceWorkerManager was instantiated.

Returns#

string

A unique id to identify the browsing context where the ServiceWorkerManager was instantiated.

Implementation of#

IServiceWorkerManager.browsingContextId

`***

enabled#

Get Signature#

get enabled(): boolean

Defined in: service-worker-manager.ts:73

Whether the ServiceWorker is enabled or not.

Returns#

boolean

Whether the ServiceWorker is enabled or not.

Implementation of#

IServiceWorkerManager.enabled

***`

ready#

Get Signature#

**get** **ready**(): Promise<void>

Defined in: service-worker-manager.ts:87

Whether the ServiceWorker is ready or not.

Returns#

Promise<void>

A Promise that resolves when the ServiceWorker is registered, or rejects if it cannot

Implementation of#

IServiceWorkerManager.ready

`***

registrationChanged#

Get Signature#

get registrationChanged(): ISignal<IServiceWorkerManager, null | ServiceWorkerRegistration>

Defined in: service-worker-manager.ts:63

A signal emitted when the registration changes.

Returns#

ISignal<IServiceWorkerManager, null | ServiceWorkerRegistration>

Signal fired when the registration changed.

Implementation of#

IServiceWorkerManager.registrationChanged

Methods#

registerStdinHandler()#

registerStdinHandler(pathnameSuffix, stdinHandler): void

Defined in: service-worker-manager.ts:96

Register a handler for stdin requests received via ServiceWorker.

Parameters#

pathnameSuffix#

string

URL pathname suffix to match such as “kernel” or “terminal”.

stdinHandler#

IStdinHandler

Returns#

void

Implementation of#

IServiceWorkerManager.registerStdinHandler