Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abrahams-wix wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions packages/sdk/src/client.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@ import type { FetchWithAuthInit } from "./utils/fetch-with-auth.js";
*/
export interface CreateClientOptions {
/**
* Optional error handler that will be called whenever an API error occurs.
* Optional error handler that the SDK calls when:
*
* Also receives {@link ActorsModule | actors} connection failures. Errors
* are usually {@linkcode Base44Error} instances — check `error.status`.
* - An API request fails.
* - A client can't connect to an {@link ActorsModule | actor}.
*
* Errors are usually {@linkcode Base44Error} instances. Check `error.status` for the HTTP status code. Returns `undefined` for network errors.
*/
onError?: (error: Error) => void;
/**
Expand Down Expand Up @@ -137,7 +139,7 @@ export interface Base44Client {
appLogs: AppLogsModule;
/** {@link AppModule | App module} for reading the app's own public configuration. */
app: AppModule;
/** {@link ActorsModule | Actors module} for subscribing to and sending messages via Cloudflare Durable Object-backed Actors. */
/** {@link ActorsModule | Actors module} for connecting to actor sessions and exchanging messages with actors. */
actors: ActorsModule;
/** {@link AuthModule | Auth module} for user authentication and management. */
auth: AuthModule;
Expand Down
Loading