SDK JavaScript : référence en temps réel
Chaque méthode du service temps réel et des chaînes, avec sa signature.
6 min de lecture·Niveau référence·Révisé le 12 oct. 2026
Ce texte anglais a été généré automatiquement à partir de l’original français et n’a pas encore été relu.
Cette page a été traduite automatiquement. La version anglaise fait foi.
#
Classe
Service en temps réel
| Propriété | Descriptif |
|---|---|
get connectionState(): ConnectionState | État actuel de la connexion. |
get isConnected(): boolean | Si le WebSocket est actuellement connecté. |
| Méthode | Descriptif |
|---|---|
onStateChange(callback: (state: ConnectionState) => void): () => void | Écoutez les changements d’état de connexion. |
onError(callback: (err: RealtimeConnectionError) => void): () => void | Écoutez les erreurs de transport de connexion en temps réel. |
connect(): void | Assurez-vous que la connexion WebSocket est ouverte. |
refreshToken(token: string): void | Actualisez le jeton JWT sur une connexion existante (pas de déconnexion). |
setAuth(token?: string): void | Définit/actualise explicitement le jeton utilisé pour l'autorisation des chaînes privées et de diffusion (parité @supabase/realtime-js setAuth). |
httpBroadcast(channel: string, event: string, payload?: Record<string, unknown>, options?: HttpBroadcastOptions): Promise<AuraResponse<null>> | Envoie une diffusion via HTTP (REST), sans connexion WebSocket ouverte (parité @supabase/realtime-js). |
setAutoReconnect(enabled: boolean, maxAttempts?: number): void | Activer/désactiver la reconnexion automatique (activée par défaut). |
disconnect(): void | Déconnectez le WebSocket et nettoyez tous les canaux. |
channel(name: string, options?: ChannelConfig): AuraChannel | Créez ou récupérez une chaîne par son nom. |
removeChannel(channel: string | AuraChannel): void | Supprimez un canal par nom ou par instance AuraChannel. |
getChannels(): AuraChannel[] | Répertoriez les chaînes actives. |
removeAllChannels(): void | Supprimez toutes les chaînes et tous les abonnements. |
#
Classe
AuraChannel
Un canal en temps réel avec une API chaînable compatible Supabase.
| Propriété | Descriptif |
|---|---|
readonly name: string | Nom de la chaîne transmis à realtime.channel(name). |
get fullName(): string | Nom complet du canal avec préfixe du projet (pour le protocole serveur) |
get isSubscribed(): boolean | Si cette chaîne a été abonnée. |
| Méthode | Descriptif |
|---|---|
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 | Enregistre un écouteur pour les événements PostgreSQL (CDC) avec le filtrage INSERT. |
off(type?: RealtimeListenType, filter?: PostgresChangesFilter | BroadcastFilter | PresenceFilter, callback?: (payload: unknown) => void): this | Supprime un ou plusieurs auditeurs du canal sans fermer le canal ni couper le WebSocket. |
subscribe(callback?: SubscribeCallback, timeoutMs?: number): this | Abonnez-vous à la chaîne. |
unsubscribe(): void | Se désabonner de la chaîne. |
send(message: BroadcastPayload): Promise<BroadcastSendStatus> | Envoie un message diffusé sur la chaîne. |
track(state: Record<string, unknown>): Promise<'ok' | 'error'> | Suivre l’état de présence de ce client. |
untrack(): Promise<'ok' | 'error'> | Arrêtez de suivre la présence. |
presenceState(): PresenceState | Obtenez l'état de présence actuel pour ce canal. |
Page générée
Cette page est générée à partir des déclarations de type et des commentaires du SDK, elle ne peut donc pas dériver du code publié. Pour des exemples concrets, lisez les guides.
Dernière mise à jour · 12 oct. 2026