Aurabase-logo
aurabasisdocumenten
documenten›JavaScript SDK reference›Realtime reference

JavaScript SDK: realtime referentie

Elke methode van de realtime service en van kanalen, met zijn handtekening.

6 min lezen·Niveau referentie·Herzien op 12 okt 2026
Deze Engelse tekst is automatisch gegenereerd op basis van het Franse origineel en is nog niet beoordeeld.
Deze pagina is automatisch vertaald. De Engelse versie is gezaghebbend.
#
Klasse

RealtimeService

EigendomBeschrijving
get connectionState(): ConnectionStateHuidige verbindingsstatus.
get isConnected(): booleanOf de WebSocket momenteel is verbonden.
MethodeBeschrijving
onStateChange(callback: (state: ConnectionState) => void): () => voidLuister naar wijzigingen in de verbindingsstatus.
onError(callback: (err: RealtimeConnectionError) => void): () => voidLuister naar realtime verbindingstransportfouten.
connect(): voidZorg ervoor dat de WebSocket-verbinding open is.
refreshToken(token: string): voidVernieuw het JWT-token op een bestaande verbinding (geen verbinding verbreken).
setAuth(token?: string): voidDefinieert/vernieuwt expliciet het token dat wordt gebruikt voor autorisatie van privé- en uitzendkanalen (pariteit @supabase/realtime-js setAuth).
httpBroadcast(channel: string, event: string, payload?: Record<string, unknown>, options?: HttpBroadcastOptions): Promise<AuraResponse<null>>Verzendt een uitzending via HTTP (REST), zonder een open WebSocket-verbinding (pariteit @supabase/realtime-js).
setAutoReconnect(enabled: boolean, maxAttempts?: number): voidAutomatisch opnieuw verbinden in-/uitschakelen (standaard ingeschakeld).
disconnect(): voidKoppel de WebSocket los en ruim alle kanalen op.
channel(name: string, options?: ChannelConfig): AuraChannelMaak of haal een kanaal op naam op.
removeChannel(channel: string | AuraChannel): voidVerwijder een kanaal op naam of op AuraChannel-instantie.
getChannels(): AuraChannel[]Lijst actieve kanalen.
removeAllChannels(): voidVerwijder alle kanalen en abonnementen.
#
Klasse

Aurakanaal

Een realtime kanaal met Supabase-compatibele, koppelbare API.

EigendomBeschrijving
readonly name: stringKanaalnaam zoals doorgegeven aan realtime.channel(name).
get fullName(): stringVolledige kanaalnaam met projectvoorvoegsel (voor serverprotocol)
get isSubscribed(): booleanOf dit kanaal is geabonneerd.
MethodeBeschrijving
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		Registreert een luisteraar voor PostgreSQL (CDC) gebeurtenissen met INSERT-filtering.
off(type?: RealtimeListenType, filter?: PostgresChangesFilter | BroadcastFilter | PresenceFilter, callback?: (payload: unknown) => void): thisVerwijdert een of meer luisteraars uit het kanaal zonder het kanaal te sluiten of de WebSocket af te sluiten.
subscribe(callback?: SubscribeCallback, timeoutMs?: number): thisAbonneer je op het kanaal.
unsubscribe(): voidAfmelden voor het kanaal.
send(message: BroadcastPayload): Promise<BroadcastSendStatus>Verzendt een uitzendbericht op het kanaal.
track(state: Record<string, unknown>): Promise<'ok' | 'error'>Volg de aanwezigheidsstatus voor deze klant.
untrack(): Promise<'ok' | 'error'>Stop met het volgen van de aanwezigheid.
presenceState(): PresenceStateHaal de huidige aanwezigheidsstatus voor dit kanaal op.
Gegenereerde pagina

Deze pagina wordt gegenereerd op basis van de typedeclaraties en opmerkingen van de SDK, zodat deze niet kan afwijken van de gepubliceerde code. Lees de handleidingen voor uitgewerkte voorbeelden.

Laatst bijgewerkt · 12 okt 2026