@jupyterlite


@jupyterlite / @jupyterlite/apputils / ServiceWorkerManager

Class: ServiceWorkerManager#

Defined in: packages/apputils/src/service-worker-manager.ts:35

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

Implements#

Constructors#

Constructor#

new ServiceWorkerManager(options): ServiceWorkerManager

Defined in: packages/apputils/src/service-worker-manager.ts:39

Construct a new ServiceWorkerManager.

Parameters#

options#

IOptions

Returns#

ServiceWorkerManager

Accessors#

browsingContextId#

Get Signature#

get browsingContextId(): string

Defined in: packages/apputils/src/service-worker-manager.ts:79

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: packages/apputils/src/service-worker-manager.ts:72

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: packages/apputils/src/service-worker-manager.ts:86

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: packages/apputils/src/service-worker-manager.ts:62

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: packages/apputils/src/service-worker-manager.ts:95

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