-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
document serviceWorker register option #3395
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
|
✔️ Deploy Preview for kit-demo ready! 🔨 Explore the source changes: c8b7315 🔍 Inspect the deploy log: https://app.netlify.com/sites/kit-demo/deploys/61e786ea691b7500071709af 😎 Browse the preview: https://deploy-preview-3395--kit-demo.netlify.app/ |
|
|
||
| An object containing zero or more of the following values: | ||
|
|
||
| - `register` - set to `false` to disable automatic service worker registration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the current wording is slightly ambiguous as it can be read as "it is set to false so that it will be disabled" or "you can set it to false to disable"
| - `register` - set to `false` to disable automatic service worker registration | |
| - `register` - whether to enable automatic service worker registration. Default is `true` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm following a similar wording style to the prerender.enabled config, and we don't really mention the default value for the config anywhere since it's already displayed in the code block at the start, so I don't think the last part is necessary
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm testand lint the project withpnpm lintandpnpm checkChangesets
pnpx changesetand following the prompts. All changesets should bepatchuntil SvelteKit 1.0