Skip to content

docs(actors): align createClient actors wording with the actors reference - #333

Open
abrahams-wix wants to merge 1 commit into
mainfrom
docs-sdk-actors-client
Open

abrahams-wix wants to merge 1 commit into
mainfrom
docs-sdk-actors-client

Conversation

@abrahams-wix

Copy link
Copy Markdown
Contributor

Summary

  • Rewrite the onError JSDoc on CreateClientOptions as a list of when the handler runs (a failed API request, or a client that can't connect to an actor).
  • Say what error.status holds: the HTTP status code, undefined for network errors.
  • Describe the actors field on Base44Client in the actors reference's terms (actor sessions, connections, messages) and drop the Cloudflare Durable Object wording.

JSDoc only. No runtime change. The generated createClient and createClientFromRequest pages update from these comments.

Notes

Test plan

  • tsc --noEmit passes in packages/sdk.
  • Regenerate with npm run create-docs-local and confirm onError renders as a list and actors shows the new description on both pages.

🤖 Generated with Claude Code

…ence

Rewrite the onError JSDoc as a list of when the handler runs, say what
error.status holds, and describe the actors field in the same terms as the
actors reference (actor sessions, connections, messages).

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/sdk@0.8.54-pr.333.b2eeefe

Prefer not to change any import paths? Install using npm alias so your code still imports @base44/sdk:

npm i "@base44/sdk@npm:@base44-preview/sdk@0.8.54-pr.333.b2eeefe"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "@base44/sdk": "npm:@base44-preview/sdk@0.8.54-pr.333.b2eeefe"
  }
}

Preview published to npm registry — try new features instantly!

@github-actions github-actions Bot added the docs-draft PR has auto-drafted documentation suggestions label Oct 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-draft PR has auto-drafted documentation suggestions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant