chore: deprecate null inject register value (#662)

* chore: deprecate `null` inject register value * chore: update usage
vite-pwa · Feb 15, 2024 · ffeacf9 · ffeacf9
1 parent aaa856b
commit ffeacf9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/src/api.ts b/src/api.ts
@@ -40,7 +40,7 @@ export function _generateBundle({ options, viteConfig, useImportRegister }: PWAP
 
   // if virtual register is requested, do not inject.
   if (options.injectRegister === 'auto')
-    options.injectRegister = useImportRegister ? null : 'script'
+    options.injectRegister = useImportRegister ? false : 'script'
 
   if ((options.injectRegister === 'script' || options.injectRegister === 'script-defer') && !existsSync(resolve(viteConfig.publicDir, FILE_SW_REGISTER))) {
     bundle[FILE_SW_REGISTER] = {

diff --git a/src/types.ts b/src/types.ts
@@ -152,7 +152,9 @@ export interface VitePWAOptions {
    *
    * `script-defer` - inject `<script defer />` in `<head>`, with `src` attribute to a generated script to register the service worker
    *
-   * `null` - do nothing, you will need to register the sw you self, or imports from `virtual:pwa-register`
+   * `null` - deprecated, use `false` instead
+   *
+   * `false` - do nothing, you will need to register the sw you self, or imports from `virtual:pwa-register`
    *
    * @default 'auto'
    */