Aura Logo
aurabasedocumentos
documentos›JavaScript SDK reference›Realtime reference

SDK JavaScript: referência em tempo real

Todo método de atendimento em tempo real e de canais, com sua assinatura.

6 min lido·Nível referência·Revisado em 12 de out. de 2026
Este texto em inglês foi gerado automaticamente a partir do original em francês e ainda não foi revisado.
Esta página foi traduzida automaticamente. A versão em inglês é oficial.
#
Classe

Serviço em tempo real

PropriedadeDescrição
get connectionState(): ConnectionStateEstado atual da conexão.
get isConnected(): booleanSe o WebSocket está conectado no momento.
MétodoDescrição
onStateChange(callback: (state: ConnectionState) => void): () => voidOuça as mudanças no estado da conexão.
onError(callback: (err: RealtimeConnectionError) => void): () => voidOuça erros de transporte de conexão em tempo real.
connect(): voidCertifique-se de que a conexão WebSocket esteja aberta.
refreshToken(token: string): voidAtualize o token JWT em uma conexão existente (sem desconexão).
setAuth(token?: string): voidDefine/atualiza explicitamente o token usado para autorização de canais privados e de transmissão (paridade @supabase/realtime-js setAuth).
httpBroadcast(channel: string, event: string, payload?: Record<string, unknown>, options?: HttpBroadcastOptions): Promise<AuraResponse<null>>Envia um broadcast via HTTP (REST), sem conexão WebSocket aberta (paridade @supabase/realtime-js).
setAutoReconnect(enabled: boolean, maxAttempts?: number): voidAtivar/desativar a reconexão automática (ativada por padrão).
disconnect(): voidDesconecte o WebSocket e limpe todos os canais.
channel(name: string, options?: ChannelConfig): AuraChannelCrie ou recupere um canal por nome.
removeChannel(channel: string | AuraChannel): voidRemova um canal por nome ou por instância do AuraChannel.
getChannels(): AuraChannel[]Listar canais ativos.
removeAllChannels(): voidRemova todos os canais e assinaturas.
#
Classe

AuraChannel

Um canal em tempo real com API encadeável compatível com Supabase.

PropriedadeDescrição
readonly name: stringNome do canal passado para realtime.channel(name).
get fullName(): stringNome completo do canal com prefixo do projeto (para protocolo do servidor)
get isSubscribed(): booleanSe este canal foi inscrito.
MétodoDescrição
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		Registra um ouvinte para eventos PostgreSQL (CDC) com filtragem INSERT.
off(type?: RealtimeListenType, filter?: PostgresChangesFilter | BroadcastFilter | PresenceFilter, callback?: (payload: unknown) => void): thisRemove um ou mais ouvintes do canal sem fechar o canal ou cortar o WebSocket.
subscribe(callback?: SubscribeCallback, timeoutMs?: number): thisInscreva-se no canal.
unsubscribe(): voidCancele a inscrição no canal.
send(message: BroadcastPayload): Promise<BroadcastSendStatus>Envia uma mensagem de transmissão no canal.
track(state: Record<string, unknown>): Promise<'ok' | 'error'>Rastreie o estado de presença deste cliente.
untrack(): Promise<'ok' | 'error'>Pare de rastrear presença.
presenceState(): PresenceStateObtenha o estado de presença atual deste canal.
Página gerada

Esta página é gerada a partir das declarações de tipo e comentários do SDK, portanto, não pode desviar do código publicado. Para exemplos resolvidos, leia os guias.

Última atualização · 12 de out. de 2026