Aurabase Logosu
aura tabanıdokümanlar
dokümanlar›JavaScript SDK reference›Realtime reference

JavaScript SDK'sı: gerçek zamanlı referans

Gerçek zamanlı hizmetin ve kanalların her yöntemi kendi imzasıyla.

6 dk. oku·Seviye referans·12 Eki 2026 tarihinde revize edildi
Bu İngilizce metin, Fransızca orijinalinden otomatik olarak oluşturulmuştur ve henüz incelenmemiştir.
Bu sayfa otomatik olarak çevrildi. İngilizce versiyonu yetkilidir.
#
Sınıf

Gerçek Zamanlı Hizmet

MülkiyetAçıklama
get connectionState(): ConnectionStateGeçerli bağlantı durumu.
get isConnected(): booleanWebSocket'in şu anda bağlı olup olmadığı.
YöntemAçıklama
onStateChange(callback: (state: ConnectionState) => void): () => voidBağlantı durumu değişikliklerini dinleyin.
onError(callback: (err: RealtimeConnectionError) => void): () => voidGerçek zamanlı bağlantı aktarım hatalarını dinleyin.
connect(): voidWebSocket bağlantısının açık olduğundan emin olun.
refreshToken(token: string): voidMevcut bir bağlantıda JWT belirtecini yenileyin (bağlantı yok).
setAuth(token?: string): voidÖzel ve yayın kanallarının yetkilendirilmesi için kullanılan belirteci açıkça tanımlar/yeniler (eşlik @supabase/realtime-js setAuth).
httpBroadcast(channel: string, event: string, payload?: Record<string, unknown>, options?: HttpBroadcastOptions): Promise<AuraResponse<null>>Açık bir WebSocket bağlantısı olmadan (eşlik @supabase/realtime-js) HTTP (REST) yoluyla bir yayın gönderir.
setAutoReconnect(enabled: boolean, maxAttempts?: number): voidOtomatik yeniden bağlanmayı etkinleştirin/devre dışı bırakın (varsayılan olarak etkindir).
disconnect(): voidWebSocket'in bağlantısını kesin ve tüm kanalları temizleyin.
channel(name: string, options?: ChannelConfig): AuraChannelAda göre bir kanal oluşturun veya alın.
removeChannel(channel: string | AuraChannel): voidBir kanalı ada veya AuraChannel örneğine göre kaldırın.
getChannels(): AuraChannel[]Aktif kanalları listeleyin.
removeAllChannels(): voidTüm kanalları ve abonelikleri kaldırın.
#
Sınıf

Aura Kanalı

Supabase uyumlu zincirlenebilir API'ye sahip gerçek zamanlı bir kanal.

MülkiyetAçıklama
readonly name: stringrealtime.channel(name) öğesine aktarıldığı şekliyle kanal adı.
get fullName(): stringProje ön ekiyle birlikte tam kanal adı (sunucu protokolü için)
get isSubscribed(): booleanBu kanalın abone olup olmadığı.
YöntemAçıklama
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		INSERT filtrelemeyle PostgreSQL (CDC) olayları için bir dinleyici kaydeder.
off(type?: RealtimeListenType, filter?: PostgresChangesFilter | BroadcastFilter | PresenceFilter, callback?: (payload: unknown) => void): thisKanalı kapatmadan veya WebSocket'i kesmeden bir veya daha fazla dinleyiciyi kanaldan kaldırır.
subscribe(callback?: SubscribeCallback, timeoutMs?: number): thisKanala abone olun.
unsubscribe(): voidKanal aboneliğinden çıkın.
send(message: BroadcastPayload): Promise<BroadcastSendStatus>Kanala bir yayın mesajı gönderir.
track(state: Record<string, unknown>): Promise<'ok' | 'error'>Bu müşterinin iletişim durumunu izleyin.
untrack(): Promise<'ok' | 'error'>Varlığı izlemeyi bırakın.
presenceState(): PresenceStateBu kanal için mevcut iletişim durumunu alın.
Oluşturulan sayfa

Bu sayfa, SDK'nın tür bildirimlerinden ve yorumlarından oluşturulduğundan, yayınlanan koddan sapamaz. Çalışılan örnekler için kılavuzları okuyun.