feat: Document the typing adjustments needed for an action that returns a result

[jswalden]

Summary by CodeRabbit

• Documentation
  • Clarified how action callbacks can return JSON-compatible results, including asynchronous values.
  • Documented the requirement to set hasResult: true so returned values are preserved.
  • Added TypeScript guidance for declaring result types in action schemas.
  • Expanded examples showing stored results being assigned to local or custom variables.
  • Updated strongly typed action examples to reflect the revised result-handling workflow.

[coderabbitai]

Warning

Review limit reached

@jswalden, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 42 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a8d7272c-2b5e-44f3-a2b2-ff9016cb2663

📥 Commits

Reviewing files that changed from the base of the PR and between 76e41a1 and d3fa281.

📒 Files selected for processing (2)

• for-developers/module-development/api-changes/v2.1.md
• for-developers/module-development/connection-basics/actions.md

📝 Walkthrough

Walkthrough

Changes

Action result documentation

Layer / File(s)	Summary
Action result contract for-developers/module-development/api-changes/v2.1.md, for-developers/module-development/connection-basics/actions.md	Documents JSON-representable and Promise-compatible callback results, the hasResult: true requirement, TypeScript result fields, and variable storage.
Typed action examples for-developers/module-development/connection-basics/actions.md	Updates the route schema and strongly typed action example to declare and return a boolean result.

Poem

Results return in JSON bright,
Typed by schemas, clear and right.
hasResult opens the door,
Variables catch what callbacks store.
Async actions gently soar.

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the PR’s main change: documenting the typing and schema updates for actions that return a result.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 2

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7ab90d83-b863-4cc3-9fc1-eada395462c5

📥 Commits

Reviewing files that changed from the base of the PR and between 358d7fd and 76e41a1.

📒 Files selected for processing (2)

• for-developers/module-development/api-changes/v2.1.md
• for-developers/module-development/connection-basics/actions.md