dokumenty›JavaScript SDK reference›Realtime reference

JavaScript SDK: odniesienie w czasie rzeczywistym

Każda metoda usługi czasu rzeczywistego i kanałów wraz z jej sygnaturą.

6 min przeczytane·Poziom odniesienie·Zmieniono 12 paź 2026

Ten tekst w języku angielskim został wygenerowany automatycznie na podstawie francuskiego oryginału i nie był jeszcze recenzowany.

Ta strona została przetłumaczona automatycznie. Wersja angielska jest miarodajna.

Klasa

Usługa czasu rzeczywistego

Nieruchomość	Opis
`get connectionState(): ConnectionState`	Aktualny stan połączenia.
`get isConnected(): boolean`	Określa, czy protokół WebSocket jest aktualnie podłączony.

Metoda	Opis
`onStateChange(callback: (state: ConnectionState) => void): () => void`	Słuchaj zmian stanu połączenia.
`onError(callback: (err: RealtimeConnectionError) => void): () => void`	Słuchaj błędów transportu połączenia w czasie rzeczywistym.
`connect(): void`	Upewnij się, że połączenie WebSocket jest otwarte.
`refreshToken(token: string): void`	Odśwież token JWT w istniejącym połączeniu (bez rozłączania).
`setAuth(token?: string): void`	Jawnie definiuje/odświeża token używany do autoryzacji kanałów prywatnych i rozgłoszeniowych (parzystość `@supabase/realtime-js` `setAuth`).
`httpBroadcast(channel: string, event: string, payload?: Record<string, unknown>, options?: HttpBroadcastOptions): Promise<AuraResponse<null>>`	Wysyła transmisję poprzez HTTP (REST) bez otwartego połączenia WebSocket (parzystość `@supabase/realtime-js`).
`setAutoReconnect(enabled: boolean, maxAttempts?: number): void`	Włącz/wyłącz automatyczne ponowne łączenie (domyślnie włączone).
`disconnect(): void`	Odłącz WebSocket i wyczyść wszystkie kanały.
`channel(name: string, options?: ChannelConfig): AuraChannel`	Utwórz lub pobierz kanał według nazwy.
`removeChannel(channel: string \| AuraChannel): void`	Usuń kanał według nazwy lub instancji AuraChannel.
`getChannels(): AuraChannel[]`	Lista aktywnych kanałów.
`removeAllChannels(): void`	Usuń wszystkie kanały i subskrypcje.

Klasa

Kanał Aura

Kanał czasu rzeczywistego z interfejsem API zgodnym z Supabase.

Nieruchomość	Opis
`readonly name: string`	Nazwa kanału przekazana do `realtime.channel(name)`.
`get fullName(): string`	Pełna nazwa kanału z prefiksem projektu (dla protokołu serwera)
`get isSubscribed(): boolean`	Czy ten kanał został subskrybowany.

Metoda	Opis
`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`	Rejestruje detektor zdarzeń PostgreSQL (CDC) z filtrowaniem INSERT.
`off(type?: RealtimeListenType, filter?: PostgresChangesFilter \| BroadcastFilter \| PresenceFilter, callback?: (payload: unknown) => void): this`	Usuwa jednego lub więcej słuchaczy z kanału bez zamykania kanału lub wycinania protokołu WebSocket.
`subscribe(callback?: SubscribeCallback, timeoutMs?: number): this`	Subskrybuj kanał.
`unsubscribe(): void`	Zrezygnuj z subskrypcji kanału.
`send(message: BroadcastPayload): Promise<BroadcastSendStatus>`	Wysyła wiadomość rozgłoszeniową na kanale.
`track(state: Record<string, unknown>): Promise<'ok' \| 'error'>`	Śledź stan obecności tego klienta.
`untrack(): Promise<'ok' \| 'error'>`	Przestań śledzić obecność.
`presenceState(): PresenceState`	Uzyskaj bieżący stan obecności dla tego kanału.

Wygenerowana strona

Ta strona jest generowana na podstawie deklaracji typów i komentarzy pakietu SDK, więc nie może odbiegać od opublikowanego kodu. Aby poznać sprawdzone przykłady, przeczytaj przewodniki.

Ostatnia aktualizacja · 12 paź 2026
↗ Edytuj na GitHubie↗ Zgłoś problem