@jupyterlite / @jupyterlite/apputils / ServiceWorkerManager
Class: ServiceWorkerManager#
Defined in: packages/apputils/src/service-worker-manager.ts:40
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:44
Construct a new ServiceWorkerManager.
Parameters#
options#
Returns#
ServiceWorkerManager
Accessors#
browsingContextId#
Get Signature#
get browsingContextId():
string
Defined in: packages/apputils/src/service-worker-manager.ts:84
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#
enabled#
Get Signature#
get enabled():
boolean
Defined in: packages/apputils/src/service-worker-manager.ts:77
Whether the ServiceWorker is enabled or not.
Returns#
boolean
Whether the ServiceWorker is enabled or not.
Implementation of#
ready#
Get Signature#
get ready():
Promise<void>
Defined in: packages/apputils/src/service-worker-manager.ts:91
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#
registrationChanged#
Get Signature#
get registrationChanged():
ISignal<IServiceWorkerManager,ServiceWorkerRegistration|null>
Defined in: packages/apputils/src/service-worker-manager.ts:67
A signal emitted when the registration changes.
Returns#
ISignal<IServiceWorkerManager, ServiceWorkerRegistration | null>
Signal fired when the registration changed.
Implementation of#
Methods#
registerStdinHandler()#
registerStdinHandler(
pathnameSuffix,stdinHandler):void
Defined in: packages/apputils/src/service-worker-manager.ts:100
Register a handler for stdin requests received via ServiceWorker.
Parameters#
pathnameSuffix#
string
URL pathname suffix to match such as “kernel” or “terminal”.
stdinHandler#
Returns#
void