{
  "id": "api/service-worker/ServiceWorkerModule",
  "title": "ServiceWorkerModule",
  "contents": "\n\n<article>\n  <div class=\"breadcrumb-container\">\n    <div class=\"breadcrumb\">\n      <script type=\"application/ld+json\">\n        {\n          \"@context\": \"http://schema.org\",\n          \"@type\": \"BreadcrumbList\",\n          \"itemListElement\": [\n            { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io//api\", \"name\": \"API\" } },\n            { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/service-worker\", \"name\": \"@angular/service-worker\" } },\n            { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/service-worker/ServiceWorkerModule\", \"name\": \"ServiceWorkerModule\" } }\n          ]\n        }\n      </script>\n        <a href=\"/api\">API</a> > <a href=\"api/service-worker\">@angular/service-worker</a>\n    </div>\n    <div class=\"github-links\">\n  <a href=\"https://github.com/angular/angular/edit/master/packages/service-worker/src/module.ts?message=docs(service-worker)%3A%20describe%20your%20change...#L153-L188\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n  <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/service-worker/src/module.ts#L153-L188\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n  </div>\n  \n  <header class=\"api-header\">\n    <h1 id=\"serviceworkermodule\">ServiceWorkerModule<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/service-worker/ServiceWorkerModule#serviceworkermodule\"><i class=\"material-icons\">link</i></a></h1>\n    \n    <label class=\"api-type-label ngmodule\">ngmodule</label>\n    \n    \n    \n  </header>\n  \n  <aio-toc class=\"embedded\"></aio-toc>\n\n  <div class=\"api-body\">\n    \n  <section class=\"short-description\">\n    \n    \n  </section>\n  \n  \n  \n  <section class=\"ngmodule-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nclass <a href=\"api/service-worker/ServiceWorkerModule\" class=\"code-anchor\">ServiceWorkerModule</a> {\n  <a class=\"code-anchor\" href=\"api/service-worker/ServiceWorkerModule#register\">static <span class=\"member-name\">register</span>(script: string, opts: SwRegistrationOptions = {}): ModuleWithProviders&#x3C;ServiceWorkerModule></a>\n}\n</code-example>\n\n  \n  \n\n</section>\n\n\n  \n\n  \n  \n  \n  \n\n  \n\n<section class=\"static-methods\">\n  <h2 id=\"static-methods\">Static methods<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/service-worker/ServiceWorkerModule#static-methods\"><i class=\"material-icons\">link</i></a></h2>\n  \n    <a id=\"register\"></a>\n<table class=\"is-full-width method-table static-method\">\n  <thead><tr><th>\n    <div class=\"with-github-links\">\n    <h3 id=\"register\">\n      register()\n      \n    <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/service-worker/ServiceWorkerModule#register\"><i class=\"material-icons\">link</i></a></h3>\n    <div class=\"github-links\">\n  <a href=\"https://github.com/angular/angular/edit/master/packages/service-worker/src/module.ts?message=docs(service-worker)%3A%20describe%20your%20change...#L161-L187\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n  <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/service-worker/src/module.ts#L161-L187\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n    </div>\n  </th></tr></thead>\n  <tbody>\n    <tr>\n      <td class=\"short-description\">\n        <p>Register the given Angular Service Worker script.</p>\n\n      </td>\n    </tr>\n  \n    <tr>\n      <td>\n        <div class=\"overload-info\">\n  \n\n  <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><a href=\"api/upgrade/static\" class=\"code-anchor\">static</a> <span class=\"member-name\">register</span>(script: string, opts: SwRegistrationOptions = {}): ModuleWithProviders&#x3C;ServiceWorkerModule></code-example>\n\n  \n\n  <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n  <table class=\"is-full-width list-table parameters-table static-method-overload-parameters\">\n  <tbody>\n  \n    <tr class=\"static-method-overload-parameter\">\n      <td class=\"param-name\">\n        <a id=\"\"></a>\n        <code>script</code>\n      </td>\n      <td class=\"param-type\"><code>string</code></td>\n      <td class=\"param-description\">\n                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     \n                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               \n      </td>\n    </tr>\n    <tr class=\"static-method-overload-parameter\">\n      <td class=\"param-name\">\n        <a id=\"\"></a>\n        <code>opts</code>\n      </td>\n      <td class=\"param-type\"><code><a href=\"api/service-worker/SwRegistrationOptions\" class=\"code-anchor\">SwRegistrationOptions</a></code></td>\n      <td class=\"param-description\">\n            <p>Optional. Default is <code>{}</code>.</p>\n      \n      </td>\n    </tr>\n  </tbody>\n</table>\n\n  \n  <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n  <p><code><a href=\"api/core/ModuleWithProviders\" class=\"code-anchor\">ModuleWithProviders</a>&#x3C;<a href=\"api/service-worker/ServiceWorkerModule\" class=\"code-anchor\">ServiceWorkerModule</a>></code></p>\n\n  \n\n\n  \n\n  \n</div>\n      </td>\n    </tr>\n  \n\n  <tr>\n      <td class=\"description\">\n        <p>If <code>enabled</code> is set to <code>false</code> in the given options, the module will behave as if service\nworkers are not supported by the browser, and the service worker will not be registered.</p>\n\n      </td>\n    </tr>\n\n  \n    </tbody>\n</table>\n\n  \n</section>\n\n  \n\n  \n\n\n  \n\n\n  \n  \n<section class=\"providers\">\n    <h2 id=\"providers\">Providers<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/service-worker/ServiceWorkerModule#providers\"><i class=\"material-icons\">link</i></a></h2>\n    <table class=\"is-full-width list-table property-table\">\n      <thead>\n        <tr>\n          <th>Provider</th>\n        </tr>\n      </thead>\n      <tbody>\n      \n        <tr>\n          <td>\n            <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box\">\n              <a href=\"api/service-worker/SwPush\" class=\"code-anchor\">SwPush</a>\n            </code-example>\n          </td>\n        </tr>\n      \n        <tr>\n          <td>\n            <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box\">\n              <a href=\"api/service-worker/SwUpdate\" class=\"code-anchor\">SwUpdate</a>\n            </code-example>\n          </td>\n        </tr>\n      \n      </tbody>\n    </table>\n  </section>\n\n  \n\n  \n  \n\n\n  \n\n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/service-worker\n - api/service-worker/SwPush\n - api/service-worker/SwRegistrationOptions\n - api/service-worker/SwUpdate\n - guide/service-worker-communications\n-->\n<!-- links from this doc:\n - /api\n - api/core/ModuleWithProviders\n - api/service-worker\n - api/service-worker/ServiceWorkerModule#providers\n - api/service-worker/ServiceWorkerModule#register\n - api/service-worker/ServiceWorkerModule#serviceworkermodule\n - api/service-worker/ServiceWorkerModule#static-methods\n - api/service-worker/SwPush\n - api/service-worker/SwRegistrationOptions\n - api/service-worker/SwUpdate\n - api/upgrade/static\n - https://github.com/angular/angular/edit/master/packages/service-worker/src/module.ts?message=docs(service-worker)%3A%20describe%20your%20change...#L153-L188\n - https://github.com/angular/angular/edit/master/packages/service-worker/src/module.ts?message=docs(service-worker)%3A%20describe%20your%20change...#L161-L187\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/service-worker/src/module.ts#L153-L188\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/service-worker/src/module.ts#L161-L187\n-->"
}