-
-
Notifications
You must be signed in to change notification settings - Fork 144
docs: web worker adapter #1013
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
Merged
Merged
docs: web worker adapter #1013
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,54 @@ | ||
| --- | ||
| title: Web Workers Adapter | ||
| description: Enable type-safe communication with Web Workers using oRPC. | ||
| --- | ||
|
|
||
| # Web Workers Adapter | ||
|
|
||
| [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Worker) allow JavaScript code to run in background threads, separate from the main thread of a web page. This prevents blocking the UI while performing computationally intensive tasks. Web Workers are also supported in modern runtimes like [Bun](https://bun.com/docs/api/workers), [Deno](https://docs.deno.com/examples/web_workers/), etc. | ||
|
|
||
| With oRPC, you can establish type-safe communication channels between your main thread and Web Workers. For additional context, see the [Message Port Adapter](/docs/adapters/message-port) guide. | ||
|
|
||
| ## Web Worker | ||
|
|
||
| Configure your Web Worker to handle oRPC requests by upgrading it with a message port handler: | ||
|
|
||
| ```ts | ||
| import { RPCHandler } from '@orpc/server/message-port' | ||
|
|
||
| const handler = new RPCHandler(router) | ||
|
|
||
| handler.upgrade(self, { | ||
| context: {}, // Provide initial context if needed | ||
| }) | ||
| ``` | ||
|
|
||
| ## Main Thread | ||
|
|
||
| Create a link to communicate with your Web Worker: | ||
|
|
||
| ```ts | ||
| import { RPCLink } from '@orpc/client/message-port' | ||
|
|
||
| export const link = new RPCLink({ | ||
| port: new Worker('some-worker.ts') | ||
| }) | ||
| ``` | ||
|
|
||
| :::details Using Web Workers in Vite Applications? | ||
| You can leverage [Vite Web Workers feature](https://vite.dev/guide/features.html#web-workers) for streamlined development: | ||
|
|
||
| ```ts | ||
| import SomeWorker from './some-worker.ts?worker' // [!code highlight] | ||
| import { RPCLink } from '@orpc/client/message-port' | ||
|
|
||
| export const link = new RPCLink({ | ||
| port: new SomeWorker() | ||
| }) | ||
| ``` | ||
|
dinwwwh marked this conversation as resolved.
|
||
|
|
||
| ::: | ||
|
|
||
| :::info | ||
| This only shows how to configure the link. For full client examples, see [Client-Side Clients](/docs/client/client-side). | ||
| ::: | ||
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.