@base44-preview/sdk 0.8.53-pr.289.08abc72 → 0.8.53-pr.289.26df536

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

@@ -73,8 +73,8 @@ export interface ActorSubscription {
     unsubscribe(): void;
 }
 /**
- * Represents a client's [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) connection to an actor session, returned after calling
- * [`connect()`](#connect). The WebSocket queues messages you send before it opens.
+ * Represents a client's WebSocket connection to an actor session, returned after calling
+ * [`connect()`](#connect). The socket queues messages you send before it opens.
  *
  * Learn more about
  * [connections](/developers/backend/resources/actors/reference#connections).
@@ -105,8 +105,8 @@ export interface Connection<N extends string = string> {
     /**
      * Sends a message to the actor.
      *
-     * The WebSocket queues messages until it opens. When you call {@linkcode Connection.close | close()},
-     * the WebSocket drops any messages you send afterward.
+     * The socket queues messages until it opens. When you call {@linkcode Connection.close | close()},
+     * the socket drops any further sent messages.
      *
      * @param data - Message to send to the actor. The type comes from {@linkcode ActorRegistry} when you register the actor there.
      *
@@ -134,11 +134,11 @@ export interface Connection<N extends string = string> {
 /**
  * Represents a reference to an actor session, identified by actor name and session ID.
  *
- * Call {@linkcode ActorRef.connect | connect()} to open the WebSocket and get a [connection](/developers/backend/resources/actors/overview#connections).
+ * Call {@linkcode ActorRef.connect | connect()} to open the WebSocket and get a [Connection](#returns).
  */
 export interface ActorRef<N extends string = string> {
     /**
-     * Creates or returns the connection for this session.
+     * Creates or returns the [Connection](#returns) for this session.
      *
      * Calling `connect()` again on the same session reference returns the same
      * connection until it closes.
@@ -147,7 +147,7 @@ export interface ActorRef<N extends string = string> {
      * [connect a client to a session](/developers/backend/resources/actors/sample-flows#connect-a-client-to-a-session).
      *
      * @param options - Optional connection settings, such as a stable connection ID.
-     * @returns The connection for this actor session.
+     * @returns The [Connection](#returns) for this actor session.
      *
      * @example
      * ```typescript
@@ -182,17 +182,19 @@ export interface ActorClient<N extends string = string> {
     (instanceId: string): ActorRef<N>;
 }
 /**
- * Actors module for interacting with [actors](/developers/backend/resources/actors/overview) from your app.
+ * Actors module for connecting a client to [actor](/developers/backend/resources/actors/overview) sessions, managing connections, and exchanging messages.
  *
  * An actor is a long-running backend process that multiple clients connect to simultaneously. A session
  * is a running instance of an actor, identified by the actor name and a session ID. Each
  * session manages its own state, storage, and client connections independently.
  *
- * The actors module provides the functionality to:
+ * The actors module supports several objects with the following functionality:
  *
- * - Manage connections: {@link ActorRef.connect | Open} and {@link Connection.close | close} a WebSocket connection to a session.
- * - Exchange messages: {@link Connection.send | Send} and {@link Connection.subscribe | listen} for messages to and from an actor.
- * - Manage subscriptions: {@link Connection.subscribe | Subscribe} and {@link ActorSubscription.unsubscribe | unsubscribe} from actor messages without closing the connection.
+ * - {@linkcode ActorRef.connect | connect()}: Open a WebSocket connection to a session.
+ * - {@linkcode Connection.subscribe | subscribe()}: Receive messages from the actor.
+ * - {@linkcode ActorSubscription.unsubscribe | unsubscribe()}: Stop receiving messages from the actor without closing the connection.
+ * - {@linkcode Connection.send | send()}: Send messages to the actor.
+ * - {@linkcode Connection.close | close()}: Close the WebSocket connection to the actor.
  *
  * For a sample flow, see
  * [connect a client to a session](/developers/backend/resources/actors/sample-flows#connect-a-client-to-a-session).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.53-pr.289.08abc72",
+  "version": "0.8.53-pr.289.26df536",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",