Interface 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. Available only in secure contexts.

    MDN Reference

    interface ServiceWorkerRegistration {
        active: ServiceWorker;
        installing: ServiceWorker;
        navigationPreload: NavigationPreloadManager;
        onupdatefound: (this: ServiceWorkerRegistration, ev: Event) => any;
        pushManager: PushManager;
        scope: string;
        updateViaCache: ServiceWorkerUpdateViaCache;
        waiting: ServiceWorker;
        addEventListener<K extends "updatefound">(
            type: K,
            listener: (
                this: ServiceWorkerRegistration,
                ev: ServiceWorkerRegistrationEventMap[K],
            ) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        dispatchEvent(event: Event): boolean;
        getNotifications(filter?: GetNotificationOptions): Promise<Notification[]>;
        removeEventListener<K extends "updatefound">(
            type: K,
            listener: (
                this: ServiceWorkerRegistration,
                ev: ServiceWorkerRegistrationEventMap[K],
            ) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        showNotification(
            title: string,
            options?: NotificationOptions,
        ): Promise<void>;
        unregister(): Promise<boolean>;
        update(): Promise<void>;
    }
    Hierarchy

    Properties

    active installing navigationPreload onupdatefound pushManager scope updateViaCache waiting

    Methods

    addEventListener dispatchEvent getNotifications removeEventListener showNotification unregister update

    Properties

    Readonlyactive

    active: ServiceWorker

    MDN Reference

    Readonlyinstalling

    installing: ServiceWorker

    MDN Reference

    ReadonlynavigationPreload

    navigationPreload: NavigationPreloadManager

    MDN Reference

    onupdatefound

    onupdatefound: (this: ServiceWorkerRegistration, ev: Event) => any

    MDN Reference

    ReadonlypushManager

    pushManager: PushManager

    MDN Reference

    Readonlyscope

    scope: string

    MDN Reference

    ReadonlyupdateViaCache

    updateViaCache: ServiceWorkerUpdateViaCache

    MDN Reference

    Readonlywaiting

    waiting: ServiceWorker

    MDN Reference

    Methods

    addEventListener

    • addEventListener<K extends "updatefound">(
          type: K,
          listener: (
              this: ServiceWorkerRegistration,
              ev: ServiceWorkerRegistrationEventMap[K],
          ) => any,
          options?: boolean | AddEventListenerOptions,
      ): void

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Type Parameters

      • K extends "updatefound"

      Parameters

      Returns void

    • addEventListener(
          type: string,
          listener: EventListenerOrEventListenerObject,
          options?: boolean | AddEventListenerOptions,
      ): void

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Parameters

      Returns void

    dispatchEvent

    • dispatchEvent(event: Event): boolean

    • 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.

      MDN Reference

      Parameters

      Returns boolean

    getNotifications

    removeEventListener

    showNotification

    unregister

    update

    Settings

    Member Visibility

    On This Page

    Properties
    Methods