Home Reference Source

import ServiceWorker from 'chrome-remote-interface-extra/lib/workers/ServiceWorker.js'

public class | source

ServiceWorker

Extends:

eventemitter3~EventEmitter → ServiceWorker

Constructor Summary

Public Constructor
public	constructor(manager: WorkerManager)

Member Summary

Private Members
private	_info: ServiceWorkerInfo
private	_manager: WorkerManager
private	_origin: string

Method Summary

Public Methods
public	controlledClients(): Array<string>
public	async deliverPushMessage(data: string): Promise<void> Delivers a push message to the supplied origin from the ServiceWorker
public	async dispatchSyncEvent(tag: string, lastChance: boolean): Promise<void>
public	isActivated(): boolean
public	isActivating(): boolean
public	isDeleted(): boolean
public	isInstalled(): boolean
public	isInstalling(): boolean
public	isNew(): boolean
public	isRedundant(): boolean
public	isRunning(): boolean
public	isStarting(): boolean
public	isStopped(): boolean
public	isStopping(): boolean
public	registrationId(): string
public	runningStatus(): string
public	scopeURL(): string
public	scriptLastModified(): number
public	scriptResponseTime(): number
public	async skipWaiting(): Promise<void> Makes the ServiceWorker skip waiting
public	async start(): Promise<void> Starts the ServiceWorker
public	status(): string Returns the ServiceWorkers status Possible status: new installing installed activating activated redundant
public	async stop(versionId: string): Promise<void> Stops the ServiceWorker
public	targetId(): string
public	toJSON(): ServiceWorkerInfo
public	async unregister(): Promise<void> Un-registers the ServiceWorker
public	async updateRegistration(): Promise<void> Updates the ServiceWorker's registrations
public	versionId(): string

Private Methods
private	_bookKeeping(updateHow: CDPServiceWorkerRegistration \| CDPServiceWorkerVersion, isVersion: boolean)
private	_destroyed()
private	_errorReported(error: CDPServiceWorkerErrorMessage)

Public Constructors

public constructor(manager: WorkerManager) source

Params:

Name	Type	Attribute	Description
manager	WorkerManager

Private Members

private _info: ServiceWorkerInfo source

private _manager: WorkerManager source

private _origin: string source

Public Methods

public controlledClients(): Array<string> source

Return:

Array<string> (nullable: true)

public async deliverPushMessage(data: string): Promise<void> source

Delivers a push message to the supplied origin from the ServiceWorker

Params:

Name	Type	Attribute	Description
data	string		The data of the message

Return:

See:

https://chromedevtools.github.io/devtools-protocol/tot/ServiceWorker#method-deliverPushMessage

public async dispatchSyncEvent(tag: string, lastChance: boolean): Promise<void> source

Params:

Name	Type	Attribute	Description
tag	string
lastChance	boolean	optional

Return:

See:

https://chromedevtools.github.io/devtools-protocol/tot/ServiceWorker#method-dispatchSyncEvent

public isActivated(): boolean source

Return:

public isActivating(): boolean source

Return:

public isDeleted(): boolean source

Return:

public isInstalled(): boolean source

Return:

public isInstalling(): boolean source

Return:

public isNew(): boolean source

Return:

public isRedundant(): boolean source

Return:

public isRunning(): boolean source

Return:

public isStarting(): boolean source

Return:

public isStopped(): boolean source

Return:

public isStopping(): boolean source

Return:

public registrationId(): string source

Return:

public runningStatus(): string source

Return:

public scopeURL(): string source

Return:

public scriptLastModified(): number source

Return:

number (nullable: true)

public scriptResponseTime(): number source

Return:

number (nullable: true)

public async skipWaiting(): Promise<void> source

Makes the ServiceWorker skip waiting

Return:

See:

https://chromedevtools.github.io/devtools-protocol/tot/ServiceWorker#method-skipWaiting

public async start(): Promise<void> source

Starts the ServiceWorker

Return:

See:

https://chromedevtools.github.io/devtools-protocol/tot/ServiceWorker#method-startWorker

public status(): string source

Returns the ServiceWorkers status Possible status:

new
installing
installed
activating
activated
redundant

Return:

public async stop(versionId: string): Promise<void> source

Stops the ServiceWorker

Params:

Name	Type	Attribute	Description
versionId	string

Return:

See:

https://chromedevtools.github.io/devtools-protocol/tot/ServiceWorker#method-stopWorker

public targetId(): string source

Return:

public toJSON(): ServiceWorkerInfo source

Return:

ServiceWorkerInfo

public async unregister(): Promise<void> source

Un-registers the ServiceWorker

Return:

See:

https://chromedevtools.github.io/devtools-protocol/tot/ServiceWorker#method-unregister

public async updateRegistration(): Promise<void> source

Updates the ServiceWorker's registrations

Return:

See:

https://chromedevtools.github.io/devtools-protocol/tot/ServiceWorker#method-updateRegistration

public versionId(): string source

Return:

Private Methods

private _bookKeeping(updateHow: CDPServiceWorkerRegistration | CDPServiceWorkerVersion, isVersion: boolean) source

Params:

Name	Type	Attribute	Description
updateHow	CDPServiceWorkerRegistration \| CDPServiceWorkerVersion
isVersion	boolean

private _destroyed() source

private _errorReported(error: CDPServiceWorkerErrorMessage) source

Params:

Name	Type	Attribute	Description
error	CDPServiceWorkerErrorMessage