@base44-preview/sdk 0.8.49-pr.289.cceffb2 → 0.8.49-pr.289.e36026d

package/dist/modules/actors.types.d.ts

@@ -140,43 +140,35 @@ export interface ActorClient<N extends string = string> {
     (instanceId: string): ActorRef<N>;
 }
 /**
- * Provides access to actors and their shared, live sessions.
+ * Use `base44.actors` to connect your frontend to [actor sessions](/developers/backend/resources/actors/overview),
+ * shared live backend processes where clients can exchange messages in realtime.
  *
- * Use `base44.actors` to connect clients to a running actor session. The actors
- * client lets you:
+ * With the Actors SDK module you can:
  *
- * - Subscribe to messages the actor sends — either broadcast to all connected
- *   clients or sent to your client directly.
- * - Send messages to the actor from the client.
+ * - Connect to a session with `base44.actors.<ActorName>(sessionId).connect()`.
+ * - Subscribe to messages the actor sends using [Connection.subscribe](#subscribe),
+ *   either broadcast to all clients or sent directly to your client.
+ * - Send messages to the actor with [Connection.send](#send).
  * - Share a session across multiple clients: any clients with the same actor
  *   name and session ID connect to the same session.
  * - Type your messages using [ActorRegistry](#actorregistry) for autocomplete
  *   and compile-time safety.
  *
- * The client works in the browser and in Node.js.
- *
- * ## Connection flow
- *
- * - Connect to a session with `base44.actors.<ActorName>(sessionId).connect()`.
- * - Subscribe to outgoing messages with [Connection.subscribe](#subscribe).
- * - Send incoming messages with [Connection.send](#send).
- * - Close the connection with [Connection.close](#close).
- *
- * See [Actors Overview](/developers/backend/resources/actors/overview)
- * for actor concepts and terminology, [Actor Class Reference](/developers/backend/resources/actors/reference)
- * for the backend class API, and [Sample Flows](/developers/backend/resources/actors/samples)
- * for common patterns.
+ * Learn more about [actors](/developers/backend/resources/actors/overview).
  *
  * ## Authentication modes
  *
- * This module is available in anonymous or user authentication mode
- * (`base44.actors`). It isn't available with service role authentication. Apps that
- * require login can reject anonymous connections in the actor's `handleConnect()` method.
- * See [Manage client connections](/developers/backend/resources/actors/samples#manage-client-connections)
- * for a sample flow.
- *
+ * This module is available in anonymous or user authentication mode.
+ * Apps that require login can reject anonymous connections in the actor's `handleConnect()` method.
+ * Learn more about [managing client connections](/developers/backend/resources/actors/samples#manage-client-connections).
+
+
  * @example
+ *
+ * The following example displays the general lifecycle of a client connected to an actor named `Chat`:
+ *
  * ```typescript
+ * Example
  * const conn = base44.actors.Chat("session-1").connect({ id: "tab-1" });
  * const sub = conn.subscribe((msg) => console.log(msg));
  * conn.send({ type: "message", text: "hi" });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.49-pr.289.cceffb2",
+  "version": "0.8.49-pr.289.e36026d",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",