Логотип Аурабаза
аурабазадокументы
документы›JavaScript SDK reference›Realtime reference

JavaScript SDK: справочник в реальном времени

Каждый метод службы реального времени и каналов со своей подписью.

6 мин читать·Уровень ссылка·Пересмотрено 12 окт. 2026 г.
Этот текст на английском языке был создан автоматически на основе французского оригинала и еще не проверялся.
Эта страница была переведена автоматически. Английская версия является авторитетной.
#
Сорт

Служба реального времени

СвойствоОписание
get connectionState(): ConnectionStateТекущее состояние соединения.
get isConnected(): booleanПодключен ли WebSocket в данный момент.
МетодОписание
onStateChange(callback: (state: ConnectionState) => void): () => voidПрослушивайте изменения состояния соединения.
onError(callback: (err: RealtimeConnectionError) => void): () => voidПрослушивайте ошибки транспорта соединений в реальном времени.
connect(): voidУбедитесь, что соединение WebSocket открыто.
refreshToken(token: string): voidОбновите токен JWT для существующего соединения (без отключения).
setAuth(token?: string): voidЯвно определяет/обновляет токен, используемый для авторизации частных и широковещательных каналов (четность @supabase/realtime-js setAuth).
httpBroadcast(channel: string, event: string, payload?: Record<string, unknown>, options?: HttpBroadcastOptions): Promise<AuraResponse<null>>Отправляет широковещательную рассылку через HTTP (REST) ​​без открытого соединения WebSocket (паритет @supabase/realtime-js).
setAutoReconnect(enabled: boolean, maxAttempts?: number): voidВключить/отключить автоматическое переподключение (включено по умолчанию).
disconnect(): voidОтключите WebSocket и очистите все каналы.
channel(name: string, options?: ChannelConfig): AuraChannelСоздайте или получите канал по имени.
removeChannel(channel: string | AuraChannel): voidУдалить канал по имени или по экземпляру AuraChannel.
getChannels(): AuraChannel[]Список активных каналов.
removeAllChannels(): voidУдалить все каналы и подписки.
#
Сорт

АураКанал

Канал реального времени с Supabase-совместимым цепным API.

СвойствоОписание
readonly name: stringИмя канала, переданное в realtime.channel(name).
get fullName(): stringПолное имя канала с префиксом проекта (для протокола сервера)
get isSubscribed(): booleanБыла ли подписка на этот канал.
МетодОписание
on<TRow = Record<string, unknown>>(type: 'postgres_changes', filter: PostgresChangesFilter & { event: 'INSERT'; }, callback: (payload: RealtimePostgresInsertPayload<TRow>) => void): AuraChannelSubscription
on<TRow = Record<string, unknown>>(type: 'postgres_changes', filter: PostgresChangesFilter & { event: 'UPDATE'; }, callback: (payload: RealtimePostgresUpdatePayload<TRow>) => void): AuraChannelSubscription
on<TRow = Record<string, unknown>>(type: 'postgres_changes', filter: PostgresChangesFilter & { event: 'DELETE'; }, callback: (payload: RealtimePostgresDeletePayload<TRow>) => void): AuraChannelSubscription
on<TRow = Record<string, unknown>>(type: 'postgres_changes', filter: PostgresChangesFilter, callback: (payload: RealtimePostgresChangesPayload<TRow>) => void): AuraChannelSubscription
on<TPayload = Record<string, unknown>>(type: 'broadcast', filter: BroadcastFilter, callback: (payload: RealtimeBroadcastEvent<TPayload>) => void): AuraChannelSubscription
on(type: 'presence', filter: PresenceFilter, callback: (payload: PresenceState | RealtimeEvent | Record<string, unknown>) => void): AuraChannelSubscription		Регистрирует прослушиватель событий PostgreSQL (CDC) с фильтрацией INSERT.
off(type?: RealtimeListenType, filter?: PostgresChangesFilter | BroadcastFilter | PresenceFilter, callback?: (payload: unknown) => void): thisУдаляет одного или нескольких прослушивателей из канала, не закрывая канал и не отключая WebSocket.
subscribe(callback?: SubscribeCallback, timeoutMs?: number): thisПодпишитесь на канал.
unsubscribe(): voidОтписаться от канала.
send(message: BroadcastPayload): Promise<BroadcastSendStatus>Отправляет широковещательное сообщение на канал.
track(state: Record<string, unknown>): Promise<'ok' | 'error'>Отслеживать состояние присутствия этого клиента.
untrack(): Promise<'ok' | 'error'>Перестаньте отслеживать присутствие.
presenceState(): PresenceStateПолучите текущее состояние присутствия для этого канала.
Сгенерированная страница

Эта страница создается на основе объявлений типов и комментариев SDK, поэтому она не может отличаться от опубликованного кода. Рабочие примеры можно найти в руководствах.

Последнее обновление · 12 окт. 2026 г.