@base44-preview/sdk 0.8.53-pr.289.545edf7 → 0.8.53-pr.289.a08165d

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

@@ -32,7 +32,7 @@ export interface ActorRegistry {
  * with [`types generate`](/developers/references/cli/commands/types-generate).
  *
  * The generated names provide autocomplete for deployed actors. To define
- * incoming and outgoing message types manually, augment {@linkcode ActorRegistry}.
+ * incoming and outgoing message types manually, augment [ActorRegistry](#actorregistry).
  */
 export interface ActorNameRegistry {
 }
@@ -44,7 +44,7 @@ type ToServerFor<N extends string> = N extends keyof ActorRegistry ? ActorRegist
     toServer: infer O;
 } ? O : unknown : unknown;
 /**
- * Configures the connection that {@linkcode ActorRef.connect | connect()} opens.
+ * Configures the connection that [`connect()`](#connect) opens.
  */
 export interface ActorConnectOptions {
     /**
@@ -53,12 +53,15 @@ export interface ActorConnectOptions {
      * To let the actor recognize a client when it reconnects, use a stable
      * value, such as an ID stored per browser tab. If you omit this property, the
      * SDK generates a new connection ID.
+     *
+     * Learn more about
+     * [connections](/developers/backend/resources/actors/reference#connections).
      */
     id?: string;
 }
 /**
  * Represents a listener for messages from the actor, registered with
- * {@linkcode Connection.subscribe | subscribe()}.
+ * [`subscribe()`](#subscribe).
  */
 export interface ActorSubscription {
     /**
@@ -105,10 +108,10 @@ export interface Connection<N extends string = string> {
     /**
      * Sends a message to the actor.
      *
-     * The socket queues messages until it opens. When you call {@linkcode Connection.close | close()},
+     * The socket queues messages until it opens. When you call [`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.
+     * @param data - Message to send to the actor. The type comes from [ActorRegistry](#actorregistry) when you register the actor there.
      *
      * @example
      * ```typescript
@@ -134,7 +137,7 @@ 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](#returns).
+ * Call [`connect()`](#connect) to open the WebSocket and get a [Connection](#returns).
  */
 export interface ActorRef<N extends string = string> {
     /**
@@ -161,7 +164,7 @@ export interface ActorRef<N extends string = string> {
  * Selects a session for a named actor.
  *
  * TypeScript infers message types when you register the actor in
- * {@linkcode ActorRegistry}. {@linkcode ActorNameRegistry}
+ * [ActorRegistry](#actorregistry). [ActorNameRegistry](#actornameregistry)
  * provides autocomplete for actor names only.
  */
 export interface ActorClient<N extends string = string> {
@@ -182,19 +185,19 @@ export interface ActorClient<N extends string = string> {
     (instanceId: string): ActorRef<N>;
 }
 /**
- * Actors module for connecting a client to an [actor](/developers/backend/resources/actors/overview) sessions, managing connections, and exchanging messages.
+ * Actors module for connecting a client to an [actor](/developers/backend/resources/actors/overview) session 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 supports several objects with the following functionality:
+ * The actors module supports the following functionality:
  *
- * - {@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.
+ * - [`connect()`](#connect): Open a WebSocket connection to a session.
+ * - [`subscribe()`](#subscribe): Receive messages from the actor.
+ * - [`unsubscribe()`](#unsubscribe): Stop receiving messages from the actor without closing the connection.
+ * - [`send()`](#send): Send messages to the actor.
+ * - [`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.545edf7",
+  "version": "0.8.53-pr.289.a08165d",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",