add Node task queues and workers docs #495
Conversation
|
|
||
| import SharedTaskQueuesBasic from '../shared/task-queues-basic.md' | ||
|
|
||
| <SharedTaskQueuesBasic |
There was a problem hiding this comment.
Not strictly related to this PR but the first paragraph is inaccurate:
From a high level, we can say that a Task Queue is exactly what the name suggests. It is a "first-in-first-out" queue for Tasks, where a Task is the context needed to execute a chunk of code that alters the "state" of a Workflow.
What about activity task queues? Those should be mentioned here as well IMHO.
There was a problem hiding this comment.
This one is exactly as written in the Go and Java docs, so I think we should discuss this issue separately. I agree that it's worth mentioning that Task Queues store both Tasks and Activities.
There was a problem hiding this comment.
We are working on more precise, reusable term definitions in the Jargon Mesh project.
LMK if you want to those meetings -
Co-authored-by: Roey Berman <roey.berman@gmail.com>
|
✔️ Deploy Preview for mystifying-fermi-1bc096 ready! 🔨 Explore the source changes: cc43f9a 🔍 Inspect the deploy log: https://app.netlify.com/sites/mystifying-fermi-1bc096/deploys/60ecadeddb486700079b19ae 😎 Browse the preview: https://deploy-preview-495--mystifying-fermi-1bc096.netlify.app |
| 1. When starting a Workflow, you must pass the `taskQueue` option to the [Connection's `workflow()` method](https://nodejs.temporal.io/api/classes/client.connection#workflow). | ||
|
|
||
| ```typescript | ||
| const workflow = connection.workflow("my-workflow", { | ||
| taskQueue: "my-task-queue", | ||
| }); | ||
|
|
||
| const result = await workflow.start(); | ||
| ``` |
There was a problem hiding this comment.
This is now outdated with the recent changes to the client package.
Let's remember to update this doc before we release the new package.
|
✔️ Deploy Preview for mystifying-fermi-1bc096 ready! 🔨 Explore the source changes: 6759d02 🔍 Inspect the deploy log: https://app.netlify.com/sites/mystifying-fermi-1bc096/deploys/60ecae10cb2d870008605da9 😎 Browse the preview: https://deploy-preview-495--mystifying-fermi-1bc096.netlify.app |
What does this PR do?
Add Task Queues and Workers sections to Node docs to line up with other languages.
Notes to reviewers