Aurabase-Logo
AurabasisDokumente
Dokumente›JavaScript SDK reference›Realtime reference

JavaScript SDK: Echtzeitreferenz

Jede Methode des Echtzeitdienstes und der Kanäle mit ihrer Signatur.

6 Min. gelesen·Ebene Referenz·Überarbeitet am 12.10.2026
Dieser englische Text wurde automatisch aus dem französischen Original generiert und wurde noch nicht überprüft.
Diese Seite wurde automatisch übersetzt. Maßgeblich ist die englische Version.
#
Klasse

RealtimeService

EigentumBeschreibung
get connectionState(): ConnectionStateAktueller Verbindungsstatus.
get isConnected(): booleanOb der WebSocket derzeit verbunden ist.
MethodeBeschreibung
onStateChange(callback: (state: ConnectionState) => void): () => voidAchten Sie auf Änderungen des Verbindungsstatus.
onError(callback: (err: RealtimeConnectionError) => void): () => voidAchten Sie auf Echtzeit-Verbindungstransportfehler.
connect(): voidStellen Sie sicher, dass die WebSocket-Verbindung geöffnet ist.
refreshToken(token: string): voidAktualisieren Sie das JWT-Token für eine bestehende Verbindung (keine Trennung).
setAuth(token?: string): voidDefiniert/aktualisiert explizit das Token, das für die Autorisierung privater und Broadcast-Kanäle verwendet wird (Parität @supabase/realtime-js setAuth).
httpBroadcast(channel: string, event: string, payload?: Record<string, unknown>, options?: HttpBroadcastOptions): Promise<AuraResponse<null>>Sendet einen Broadcast über HTTP (REST), ohne offene WebSocket-Verbindung (Parität @supabase/realtime-js).
setAutoReconnect(enabled: boolean, maxAttempts?: number): voidAutomatische Wiederverbindung aktivieren/deaktivieren (standardmäßig aktiviert).
disconnect(): voidTrennen Sie den WebSocket und bereinigen Sie alle Kanäle.
channel(name: string, options?: ChannelConfig): AuraChannelErstellen Sie einen Kanal nach Namen oder rufen Sie ihn ab.
removeChannel(channel: string | AuraChannel): voidEntfernen Sie einen Kanal nach Namen oder nach AuraChannel-Instanz.
getChannels(): AuraChannel[]Aktive Kanäle auflisten.
removeAllChannels(): voidEntfernen Sie alle Kanäle und Abonnements.
#
Klasse

AuraChannel

Ein Echtzeitkanal mit Supabase-kompatibler verkettbarer API.

EigentumBeschreibung
readonly name: stringKanalname, wie er an realtime.channel(name) übergeben wurde.
get fullName(): stringVollständiger Kanalname mit Projektpräfix (für Serverprotokoll)
get isSubscribed(): booleanOb dieser Kanal abonniert wurde.
MethodeBeschreibung
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		Registriert einen Listener für PostgreSQL (CDC)-Ereignisse mit INSERT-Filterung.
off(type?: RealtimeListenType, filter?: PostgresChangesFilter | BroadcastFilter | PresenceFilter, callback?: (payload: unknown) => void): thisEntfernt einen oder mehrere Listener aus dem Kanal, ohne den Kanal zu schließen oder den WebSocket zu unterbrechen.
subscribe(callback?: SubscribeCallback, timeoutMs?: number): thisAbonnieren Sie den Kanal.
unsubscribe(): voidAbonnieren Sie den Kanal.
send(message: BroadcastPayload): Promise<BroadcastSendStatus>Sendet eine Broadcast-Nachricht auf dem Kanal.
track(state: Record<string, unknown>): Promise<'ok' | 'error'>Verfolgen Sie den Anwesenheitsstatus für diesen Client.
untrack(): Promise<'ok' | 'error'>Hören Sie auf, die Anwesenheit zu verfolgen.
presenceState(): PresenceStateRufen Sie den aktuellen Präsenzstatus für diesen Kanal ab.
Generierte Seite

Diese Seite wird aus den Typdeklarationen und Kommentaren des SDK generiert, sodass sie nicht vom veröffentlichten Code abweichen kann. Ausgearbeitete Beispiele finden Sie in den Leitfäden.

Zuletzt aktualisiert · 12.10.2026