-
Notifications
You must be signed in to change notification settings - Fork 24.8k
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
docs: add Web Worker guide #29633
Closed
Closed
docs: add Web Worker guide #29633
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Using Web Workers with Angular CLI | ||
|
||
[Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) allow you to run CPU intensive computations in a background thread, freeing the main thread to update the user interface. | ||
|
||
If you find your application becomes unresponsive while processing data, using Web Workers can help. | ||
|
||
## Adding a Web Worker | ||
|
||
You can add a web worker anywhere in your application. If the file that contains your expensive computation is `src/app/app.component.ts`, you can add a Web Worker using `ng generate web-worker app`. | ||
|
||
Running this command will: | ||
|
||
- configure your project to use Web Workers, if it isn't already. | ||
- add `src/app/app.worker.ts` with scaffolded code to receive messages: | ||
|
||
```typescript | ||
addEventListener('message', ({ data }) => { | ||
const response = `worker response to ${data}`; | ||
postMessage(response); | ||
}); | ||
``` | ||
|
||
- add scaffolded code to `src/app/app.component.ts` to use the worker: | ||
|
||
```typescript | ||
if (typeof Worker !== 'undefined') { | ||
// Create a new | ||
const worker = new Worker('./app.worker', { type: 'module' }); | ||
worker.onmessage = ({ data }) => { | ||
console.log('page got message: $\{data\}'); | ||
}; | ||
worker.postMessage('hello'); | ||
} else { | ||
// Web Workers are not supported in this environment. | ||
// You should add a fallback so that your program still executes correctly. | ||
} | ||
``` | ||
|
||
After the initial scaffolding, you will need to refactor your code to use the Web Worker by sending messages to and from. | ||
|
||
## Caveats | ||
|
||
There are two important things to keep in mind when using Web Workers in Angular projects: | ||
|
||
- Some environments or platforms, like `@angular/platform-server` used in [Server-side Rendering](guide/universal), don't support Web Workers. You have to provide a fallback mechanism to perform the computations that the worker would perform to ensure your application will work in these environments. | ||
- Running Angular itself in a Web Worker via [**@angular/platform-webworker**](api/platform-webworker) is not yet supported in Angular CLI. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
💯