Skip to content

docs(actors): update JSDoc for actors SDK module - #289

Open
abrahams-wix wants to merge 2 commits into
mainfrom
docs/sdk-actors
Open

abrahams-wix wants to merge 2 commits into
mainfrom
docs/sdk-actors

Conversation

@abrahams-wix

Copy link
Copy Markdown
Contributor

Summary

  • Rewrites JSDoc across actors.types.ts to align with established terminology and writing style
  • Replaces internal implementation-focused comments with developer-facing descriptions
  • Adds full @param, @returns, and @example coverage on all public methods
  • Aligns terminology with the Actors overview and reference docs: session vs instance, client vs page, incoming/outgoing message direction

🤖 Generated with Claude Code

Rewrites JSDoc across actors.types.ts to align with established terminology and writing style: session vs instance, client vs page, incoming/outgoing message direction, and full @param/@returns/@example coverage on all public methods.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 22, 2026

Copy link
Copy Markdown

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/sdk@0.8.48-pr.289.b9ea964

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.48-pr.289.b9ea964"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "@base44/sdk": "npm:@base44-preview/sdk@0.8.48-pr.289.b9ea964"
  }
}

Preview published to npm registry — try new features instantly!

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added the docs-draft PR has auto-drafted documentation suggestions label Sep 22, 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