Skip to Content

useLive

Hook nghe một kênh realtime của app và gọi lại hàm của bạn mỗi khi server phát tin bằng broadcast.

Cách dùng

app/orders/page.tsx
import { useApiClient } from "app/api"; import { useLive, useRequest } from "app/hooks"; export default function OrdersBoard() { const api = useApiClient(); const { data, refresh } = useRequest(() => api.orders.list({ status: "new" })); useLive("orders", () => refresh()); // ai đổi đơn thì danh sách tải lại // … }
app/orders/repository.ts
import { broadcast } from "manh/realtime"; // sau khi ghi xong broadcast("orders", { id: order.id });

Chữ ký

app/hooks.ts
function useLive<T = unknown>( channel: string | string[], onMessage: (data: T, channel: string) => void, opts?: { user?: boolean }, ): { connected: boolean };

Tham số

  • channel: tên kênh, hoặc mảng tên kênh. Tên gồm chữ thường, số và : _ -, tối đa 64 ký tự.
  • onMessage(data, channel): chạy với dữ liệu broadcast gửi và tên kênh nhận được tin.
  • opts.user: true thì nghe thêm kênh riêng user:<id của bạn>. Cần đã đăng nhập: hook gửi token của signIn để chứng minh id.

Trả về

{ connected }: true khi đang nối với server. Mất kết nối thì hook tự nối lại, chờ lâu dần tới tối đa 30 giây giữa hai lần thử.

Ví dụ

Báo cho đúng một người khi được giao việc:

app/layout.tsx
const { notification } = App.useApp(); useLive("tasks", (m: any, channel) => { if (channel.startsWith("user:")) notification.info({ message: `Bạn được giao việc #${m.id}` }); }, { user: true });
app/tasks/repository.ts
broadcast(`user:${task.assigneeId}`, { type: "assigned", id: task.id });
  • Kênh không phải user:<id> thì ai mở app cũng nghe được. Chỉ gửi id hoặc tín hiệu “có thay đổi”, rồi tải lại dữ liệu qua API (API kiểm quyền).
  • Gửi tin nhỏ. Tải chi tiết bằng useApiClient.
  • Mỗi gói giới hạn số kết nối realtime cùng lúc của một app (Free 100).

Bước tiếp theo

Cập nhật