Elgato_dark/angular
1
0
Fork 0
mirror of https://github.com/angular/angular synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

build: set up markdown pipeline for service-workers section (#53290)

Browse source 
Set up the markdown pipeline to include the required source files.

PR Close #53290
This commit is contained in:
Joey Perrott 2023-11-30 19:13:38 +00:00 committed by Dylan Hunn
parent 97e6e04611
commit df13433035
3 changed files with 26 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
adev/src/content/ecosystem/BUILD.bazel Normal file
View file

@ -0,0 +1,8 @@
load("@npm//@angular/build-tooling/bazel/markdown_to_html:markdown_to_html.bzl", "markdown_to_html")
markdown_to_html(
name = "ecosystem",
srcs = glob([
"*.md",
]),
)

14
adev/src/content/ecosystem/service-workers/BUILD.bazel Normal file
View file

@ -0,0 +1,14 @@
load("@npm//@angular/build-tooling/bazel/markdown_to_html:markdown_to_html.bzl", "markdown_to_html")
markdown_to_html(
name = "service-workers",
srcs = glob([
"*.md",
]),
data = [
"//adev/src/content/examples/service-worker-getting-started:src/app/check-for-update.service.ts",
"//adev/src/content/examples/service-worker-getting-started:src/app/handle-unrecoverable-state.service.ts",
"//adev/src/content/examples/service-worker-getting-started:src/app/log-update.service.ts",
"//adev/src/content/examples/service-worker-getting-started:src/app/prompt-update.service.ts",
],
)

8
adev/src/content/ecosystem/service-workers/communications.md
View file

@ -23,7 +23,7 @@ The `versionUpdates` is an `Observable` property of `SwUpdate` and emits four ev
| `VersionReadyEvent` | Emitted when a new version of the app is available to be activated by clients. It may be used to notify the user of an available update or prompt them to refresh the page. |
| `VersionInstallationFailedEvent` | Emitted when the installation of a new version failed. It may be used for logging/monitoring purposes. |
<docs-code header="log-update.service.ts" path="service-worker-getting-started/src/app/log-update.service.ts" visibleRegion="sw-update"/>
<docs-code header="log-update.service.ts" path="adev/src/content/examples/service-worker-getting-started/src/app/log-update.service.ts" visibleRegion="sw-update"/>
### Checking for updates
@ -33,7 +33,7 @@ However, you might choose to manually check for updates if you have a site that
Do this with the `checkForUpdate()` method:
<docs-code header="check-for-update.service.ts" path="service-worker-getting-started/src/app/check-for-update.service.ts"/>
<docs-code header="check-for-update.service.ts" path="adev/src/content/examples/service-worker-getting-started/src/app/check-for-update.service.ts"/>
This method returns a `Promise<boolean>` which indicates if an update is available for activation.
The check might fail, which will cause a rejection of the `Promise`.
@ -55,7 +55,7 @@ Alternatively, you might want to define a different [registration strategy](api/
You can update an existing tab to the latest version by reloading the page as soon as a new version is ready.
To avoid disrupting the user's progress, it is generally a good idea to prompt the user and let them confirm that it is OK to reload the page and update to the latest version:
<docs-code header="prompt-update.service.ts" path="service-worker-getting-started/src/app/prompt-update.service.ts" visibleRegion="sw-version-ready"/>
<docs-code header="prompt-update.service.ts" path="adev/src/content/examples/service-worker-getting-started/src/app/prompt-update.service.ts" visibleRegion="sw-version-ready"/>
<docs-callout important title="Safety of updating without reloading">
Calling `activateUpdate()` updates a tab to the latest version without reloading the page, but this could break the application.
@ -95,7 +95,7 @@ That particular application version is broken and there is no way to fix the sta
In such cases, the service worker notifies the client by sending an `UnrecoverableStateEvent` event.
Subscribe to `SwUpdate#unrecoverable` to be notified and handle these errors.
<docs-code header="handle-unrecoverable-state.service.ts" path="service-worker-getting-started/src/app/handle-unrecoverable-state.service.ts" visibleRegion="sw-unrecoverable-state"/>
<docs-code header="handle-unrecoverable-state.service.ts" path="adev/src/content/examples/service-worker-getting-started/src/app/handle-unrecoverable-state.service.ts" visibleRegion="sw-unrecoverable-state"/>
## More on Angular service workers