ServiceWorkerRegistration

This ServiceWorker API interface represents the service worker registration. You register a service worker to control one or more pages that share the same origin.

Hierarchy

EventTarget
- ServiceWorkerRegistration

Index

Properties

Methods

Properties

EventTarget

EventTarget: object

Type declaration

constructor: function
- new __type(): EventTarget
- - Defined in node_modules/typescript/lib/lib.dom.d.ts:5534
  Returns EventTarget
prototype: EventTarget

active

active: ServiceWorker | null

installing

installing: ServiceWorker | null

navigationPreload

navigationPreload: NavigationPreloadManager

onupdatefound

onupdatefound: function | null

pushManager

pushManager: PushManager

scope

scope: string

sync

sync: SyncManager

updateViaCache

updateViaCache: ServiceWorkerUpdateViaCache

waiting

waiting: ServiceWorker | null

Methods

addEventListener

addEventListener<K>(type: K, listener: function, options?: boolean | AddEventListenerOptions): void
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15148
Type parameters
- K: keyof ServiceWorkerRegistrationEventMap
Parameters
- type: K
- listener: function
  - - (this: ServiceWorkerRegistration, ev: ServiceWorkerRegistrationEventMap[K]): any
    - Parameters
      - this: ServiceWorkerRegistration
      - ev: ServiceWorkerRegistrationEventMap[K]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15149
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5526
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Parameters
- event: Event
Returns boolean

getNotifications

getNotifications(filter?: GetNotificationOptions): Promise<Notification[]>

- Defined in node_modules/typescript/lib/lib.dom.d.ts:15144
Parameters
- Optional filter: GetNotificationOptions
Returns Promise<Notification[]>

removeEventListener

removeEventListener<K>(type: K, listener: function, options?: boolean | EventListenerOptions): void
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15150
Type parameters
- K: keyof ServiceWorkerRegistrationEventMap
Parameters
- type: K
- listener: function
  - - (this: ServiceWorkerRegistration, ev: ServiceWorkerRegistrationEventMap[K]): any
    - Parameters
      - this: ServiceWorkerRegistration
      - ev: ServiceWorkerRegistrationEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15151
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

showNotification

showNotification(title: string, options?: NotificationOptions): Promise<void>

- Defined in node_modules/typescript/lib/lib.dom.d.ts:15145
Parameters
- title: string
- Optional options: NotificationOptions
Returns Promise<void>

unregister

unregister(): Promise<boolean>

- Defined in node_modules/typescript/lib/lib.dom.d.ts:15146
Returns Promise<boolean>

update

update(): Promise<void>

- Defined in node_modules/typescript/lib/lib.dom.d.ts:15147
Returns Promise<void>

Hierarchy

Index

Properties

Methods

Properties

EventTarget

Type declaration

constructor: function

Returns EventTarget

prototype: EventTarget

active

installing

navigationPreload

onupdatefound

pushManager

scope

sync

updateViaCache

waiting

Methods

addEventListener

Type parameters

K: keyof ServiceWorkerRegistrationEventMap

Parameters

type: K

listener: function

Parameters

this: ServiceWorkerRegistration

ev: ServiceWorkerRegistrationEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

dispatchEvent

Parameters

event: Event

Returns boolean

getNotifications

Parameters

Optional filter: GetNotificationOptions

Returns Promise<Notification[]>

removeEventListener

Type parameters

K: keyof ServiceWorkerRegistrationEventMap

Parameters

type: K

listener: function

Parameters

this: ServiceWorkerRegistration

ev: ServiceWorkerRegistrationEventMap[K]

Returns any

Optional options: boolean | EventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | EventListenerOptions

Returns void

showNotification

Parameters

title: string

Optional options: NotificationOptions

Returns Promise<void>

unregister

Returns Promise<boolean>

update

Returns Promise<void>