@base44-preview/sdk 0.8.49-pr.289.92846f0 → 0.8.49-pr.289.cceffb2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -140,19 +140,32 @@ export interface ActorClient<N extends string = string> {
|
|
|
140
140
|
(instanceId: string): ActorRef<N>;
|
|
141
141
|
}
|
|
142
142
|
/**
|
|
143
|
-
*
|
|
144
|
-
* shared live backend processes where clients exchange messages in realtime.
|
|
143
|
+
* Provides access to actors and their shared, live sessions.
|
|
145
144
|
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
* -
|
|
145
|
+
* Use `base44.actors` to connect clients to a running actor session. The actors
|
|
146
|
+
* client lets you:
|
|
147
|
+
*
|
|
148
|
+
* - Subscribe to messages the actor sends — either broadcast to all connected
|
|
149
|
+
* clients or sent to your client directly.
|
|
150
|
+
* - Send messages to the actor from the client.
|
|
150
151
|
* - Share a session across multiple clients: any clients with the same actor
|
|
151
152
|
* name and session ID connect to the same session.
|
|
152
153
|
* - Type your messages using [ActorRegistry](#actorregistry) for autocomplete
|
|
153
154
|
* and compile-time safety.
|
|
154
155
|
*
|
|
155
|
-
*
|
|
156
|
+
* The client works in the browser and in Node.js.
|
|
157
|
+
*
|
|
158
|
+
* ## Connection flow
|
|
159
|
+
*
|
|
160
|
+
* - Connect to a session with `base44.actors.<ActorName>(sessionId).connect()`.
|
|
161
|
+
* - Subscribe to outgoing messages with [Connection.subscribe](#subscribe).
|
|
162
|
+
* - Send incoming messages with [Connection.send](#send).
|
|
163
|
+
* - Close the connection with [Connection.close](#close).
|
|
164
|
+
*
|
|
165
|
+
* See [Actors Overview](/developers/backend/resources/actors/overview)
|
|
166
|
+
* for actor concepts and terminology, [Actor Class Reference](/developers/backend/resources/actors/reference)
|
|
167
|
+
* for the backend class API, and [Sample Flows](/developers/backend/resources/actors/samples)
|
|
168
|
+
* for common patterns.
|
|
156
169
|
*
|
|
157
170
|
* ## Authentication modes
|
|
158
171
|
*
|