@cloudbase/js-sdk 3.9.4 → 3.9.5-alpha.0

package/core.d.ts

@@ -38,6 +38,7 @@ declare namespace cloudbase {
   type OrmClient = import('@cloudbase/js-sdk/model').OrmClient
   type OrmRawQueryClient = import('@cloudbase/js-sdk/model').OrmRawQueryClient
   type IMySqlClient = import('@cloudbase/js-sdk/mysql').IMySqlClient
+  type RealtimeClient = import('@cloudbase/realtime-js').RealtimeClient
   type AI = import('@cloudbase/js-sdk/ai').AI
   type CloudbaseAdapter = import('@cloudbase/adapter-interface').CloudbaseAdapter
   type ResponseObject = import('@cloudbase/adapter-interface').ResponseObject
@@ -751,6 +752,26 @@ declare namespace cloudbase.app {
     mysql: IMySqlClient
     rdb: IMySqlClient
 
+    /**
+     * Realtime 客户端（Broadcast / Presence / Postgres CDC）
+     *
+     * WebSocket 地址为 `wss://{GW}/v1/realtime/websocket?apikey={accessToken}&vsn=1.0.0`。
+     *
+     * 浏览器 / Node / 微信小程序均通过 `app.realtime()` 获取客户端。
+     * 小程序不要单独 `new RealtimeClient()`，需使用已注册 adapter 的 `wsClass`。
+     * 使用前需先登录（如 `auth.signInAnonymously()`）；没有登录态时会在控制台提示。
+     *
+     * @example
+     * ```javascript
+     * const app = cloudbase.init({ env: 'xxxx-yyy' })
+     * const realtime = app.realtime()
+     * const channel = realtime.channel('room')
+     * channel.on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))
+     * channel.subscribe()
+     * ```
+     */
+    realtime(): RealtimeClient
+
     ai(options?: { baseUrl?: string }): AI
 
     apis: ICloudbaseApis