SDK de JavaScript: referencia en tiempo real
Cada método del servicio en tiempo real y de canales, con su firma.
6 min leer·Nivel referencia·Revisado el 12 oct 2026
Este texto en inglés se generó automáticamente a partir del original en francés y aún no ha sido revisado.
Esta página fue traducida automáticamente. La versión en inglés es autorizada.
#
clase
Servicio en tiempo real
| Propiedad | Descripción |
|---|---|
get connectionState(): ConnectionState | Estado de conexión actual. |
get isConnected(): boolean | Si el WebSocket está conectado actualmente. |
| Método | Descripción |
|---|---|
onStateChange(callback: (state: ConnectionState) => void): () => void | Escuche los cambios en el estado de la conexión. |
onError(callback: (err: RealtimeConnectionError) => void): () => void | Escuche los errores de transporte de conexión en tiempo real. |
connect(): void | Asegúrese de que la conexión WebSocket esté abierta. |
refreshToken(token: string): void | Actualice el token JWT en una conexión existente (sin desconexión). |
setAuth(token?: string): void | Define/actualiza explícitamente el token utilizado para la autorización de canales privados y de transmisión (paridad @supabase/realtime-js setAuth). |
httpBroadcast(channel: string, event: string, payload?: Record<string, unknown>, options?: HttpBroadcastOptions): Promise<AuraResponse<null>> | Envía una transmisión vía HTTP (REST), sin una conexión WebSocket abierta (paridad @supabase/realtime-js). |
setAutoReconnect(enabled: boolean, maxAttempts?: number): void | Activar/desactivar la reconexión automática (activada de forma predeterminada). |
disconnect(): void | Desconecte el WebSocket y limpie todos los canales. |
channel(name: string, options?: ChannelConfig): AuraChannel | Crea o recupera un canal por nombre. |
removeChannel(channel: string | AuraChannel): void | Eliminar un canal por nombre o por instancia de AuraChannel. |
getChannels(): AuraChannel[] | Listar canales activos. |
removeAllChannels(): void | Eliminar todos los canales y suscripciones. |
#
clase
AuraChannel
Un canal en tiempo real con API encadenable compatible con Supabase.
| Propiedad | Descripción |
|---|---|
readonly name: string | Nombre del canal pasado a realtime.channel(name). |
get fullName(): string | Nombre completo del canal con prefijo de proyecto (para protocolo de servidor) |
get isSubscribed(): boolean | Si este canal ha sido suscrito. |
| Método | Descripción |
|---|---|
on<TRow = Record<string, unknown>>(type: 'postgres_changes', filter: PostgresChangesFilter & { event: 'INSERT'; }, callback: (payload: RealtimePostgresInsertPayload<TRow>) => void): AuraChannelSubscriptionon<TRow = Record<string, unknown>>(type: 'postgres_changes', filter: PostgresChangesFilter & { event: 'UPDATE'; }, callback: (payload: RealtimePostgresUpdatePayload<TRow>) => void): AuraChannelSubscriptionon<TRow = Record<string, unknown>>(type: 'postgres_changes', filter: PostgresChangesFilter & { event: 'DELETE'; }, callback: (payload: RealtimePostgresDeletePayload<TRow>) => void): AuraChannelSubscriptionon<TRow = Record<string, unknown>>(type: 'postgres_changes', filter: PostgresChangesFilter, callback: (payload: RealtimePostgresChangesPayload<TRow>) => void): AuraChannelSubscriptionon<TPayload = Record<string, unknown>>(type: 'broadcast', filter: BroadcastFilter, callback: (payload: RealtimeBroadcastEvent<TPayload>) => void): AuraChannelSubscriptionon(type: 'presence', filter: PresenceFilter, callback: (payload: PresenceState | RealtimeEvent | Record<string, unknown>) => void): AuraChannelSubscription | Registra un oyente para eventos PostgreSQL (CDC) con filtrado INSERT. |
off(type?: RealtimeListenType, filter?: PostgresChangesFilter | BroadcastFilter | PresenceFilter, callback?: (payload: unknown) => void): this | Elimina uno o más oyentes del canal sin cerrar el canal ni cortar el WebSocket. |
subscribe(callback?: SubscribeCallback, timeoutMs?: number): this | Suscríbete al canal. |
unsubscribe(): void | Darse de baja del canal. |
send(message: BroadcastPayload): Promise<BroadcastSendStatus> | Envía un mensaje de difusión en el canal. |
track(state: Record<string, unknown>): Promise<'ok' | 'error'> | Seguimiento del estado de presencia de este cliente. |
untrack(): Promise<'ok' | 'error'> | Deja de rastrear la presencia. |
presenceState(): PresenceState | Obtenga el estado de presencia actual de este canal. |
página generada
Esta página se genera a partir de las declaraciones de tipo y los comentarios del SDK, por lo que no puede derivarse del código publicado. Para ver ejemplos resueltos, lea las guías.
Última actualización · 12 oct 2026