angular__angular/goldens/public-api/service-worker/index.md

## API Report File for "@angular/service-worker"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { EnvironmentProviders } from '@angular/core';
import * as i0 from '@angular/core';
import { ModuleWithProviders } from '@angular/core';
import { Observable } from 'rxjs';

// @public
export interface NoNewVersionDetectedEvent {
    // (undocumented)
    type: 'NO_NEW_VERSION_DETECTED';
    // (undocumented)
    version: {
        hash: string;
        appData?: Object;
    };
}

// @public
export function provideServiceWorker(script: string, options?: SwRegistrationOptions): EnvironmentProviders;

// @public (undocumented)
export class ServiceWorkerModule {
    static register(script: string, options?: SwRegistrationOptions): ModuleWithProviders<ServiceWorkerModule>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<ServiceWorkerModule, never>;
    // (undocumented)
    static ɵinj: i0.ɵɵInjectorDeclaration<ServiceWorkerModule>;
    // (undocumented)
    static ɵmod: i0.ɵɵNgModuleDeclaration<ServiceWorkerModule, never, never, never>;
}

// @public
export class SwPush {
    constructor(sw: NgswCommChannel);
    get isEnabled(): boolean;
    readonly messages: Observable<object>;
    readonly notificationClicks: Observable<{
        action: string;
        notification: NotificationOptions & {
            title: string;
        };
    }>;
    requestSubscription(options: {
        serverPublicKey: string;
    }): Promise<PushSubscription>;
    readonly subscription: Observable<PushSubscription | null>;
    unsubscribe(): Promise<void>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<SwPush, never>;
    // (undocumented)
    static ɵprov: i0.ɵɵInjectableDeclaration<SwPush>;
}

// @public
export abstract class SwRegistrationOptions {
    enabled?: boolean;
    registrationStrategy?: string | (() => Observable<unknown>);
    scope?: string;
}

// @public
export class SwUpdate {
    constructor(sw: NgswCommChannel);
    activateUpdate(): Promise<boolean>;
    checkForUpdate(): Promise<boolean>;
    get isEnabled(): boolean;
    readonly unrecoverable: Observable<UnrecoverableStateEvent>;
    readonly versionUpdates: Observable<VersionEvent>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<SwUpdate, never>;
    // (undocumented)
    static ɵprov: i0.ɵɵInjectableDeclaration<SwUpdate>;
}

// @public
export interface UnrecoverableStateEvent {
    // (undocumented)
    reason: string;
    // (undocumented)
    type: 'UNRECOVERABLE_STATE';
}

// @public
export interface VersionDetectedEvent {
    // (undocumented)
    type: 'VERSION_DETECTED';
    // (undocumented)
    version: {
        hash: string;
        appData?: object;
    };
}

// @public
export type VersionEvent = VersionDetectedEvent | VersionInstallationFailedEvent | VersionReadyEvent | NoNewVersionDetectedEvent;

// @public
export interface VersionInstallationFailedEvent {
    // (undocumented)
    error: string;
    // (undocumented)
    type: 'VERSION_INSTALLATION_FAILED';
    // (undocumented)
    version: {
        hash: string;
        appData?: object;
    };
}

// @public
export interface VersionReadyEvent {
    // (undocumented)
    currentVersion: {
        hash: string;
        appData?: object;
    };
    // (undocumented)
    latestVersion: {
        hash: string;
        appData?: object;
    };
    // (undocumented)
    type: 'VERSION_READY';
}

// (No @packageDocumentation comment for this package)

```