docs(jsdoc): annotate workflow runtime and client APIs#819
Open
Jeevansm25 wants to merge 3 commits into
Open
Conversation
Signed-off-by: JEEVAN S M IIIT Dharwad <22bcs049@iiitdwd.ac.in>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #819 +/- ##
============================================
- Coverage 100.00% 31.30% -68.70%
============================================
Files 1 138 +137
Lines 6 3725 +3719
Branches 1 564 +563
============================================
+ Hits 6 1166 +1160
- Misses 0 2511 +2511
- Partials 0 48 +48 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Author
|
follow up on this PR. The branch is rebased and checks are passing. Would appreciate a review whenever the maintainers hav bandwidth |
WhitWaldo
approved these changes
May 27, 2026
Contributor
WhitWaldo
left a comment
There was a problem hiding this comment.
Looks great - thank you for putting this one together as well. Excellent work!
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Closes #796
This PR adds comprehensive JSDoc annotations across the Dapr Workflow subsystem, covering workflow clients, orchestration runtime APIs, workflow state models, orchestration primitives, and workflow-related type definitions.
The goal is to improve IntelliSense, IDE hover documentation, discoverability, and onboarding experience for developers building durable workflows with the Dapr JavaScript SDK.
Covered Areas
Workflow Client
DaprWorkflowClientWorkflowStateWorkflowFailureDetailsWorkflow Runtime
WorkflowRuntimeWorkflowContextWorkflowActivityContextWorkflowRuntimeStatusWorkflow Type Definitions
Documentation Added
This PR adds:
WorkflowContext Coverage
The orchestration APIs in
WorkflowContextwere documented in detail, including:callActivitycallChildWorkflowcreateTimerwaitForExternalEventcontinueAsNewwhenAllwhenAnyThe documentation explains deterministic workflow execution requirements, replay-safe orchestration behavior, and durable execution semantics.
Notes