Function useRealtime

useRealtime<T = any>(
table: string,
options?: UseRealtimeOptions<T>,
): UseRealtimeReturn<T>

Subscribe to real-time database changes for a table.

Type Parameters

T = any

Parameters

table: string
options: UseRealtimeOptions<T> = {}

Returns UseRealtimeReturn<T>

Example

function TaskList() {
  const { data: tasks, refetch } = useEndpoint('list_tasks');
  useRealtime('tasks', {
    onInsert: () => refetch(),
    onUpdate: () => refetch(),
    onDelete: () => refetch(),
  });
  return <ul>{tasks?.map(t => <li key={t.id}>{t.title}</li>)}</ul>;
}