ऑराबेस लोगो
aurabaseडॉक्स
डॉक्स›JavaScript SDK reference›Realtime reference

जावास्क्रिप्ट एसडीके: वास्तविक समय संदर्भ

रीयलटाइम सेवा और चैनलों की प्रत्येक विधि, इसके हस्ताक्षर के साथ।

6 मि॰ पढ़ें·स्तर संदर्भ·12 अक्टू॰ 2026 पर संशोधित
यह अंग्रेजी पाठ फ़्रेंच मूल से स्वचालित रूप से उत्पन्न हुआ था और अभी तक इसकी समीक्षा नहीं की गई है।
यह पृष्ठ स्वचालित रूप से अनुवादित किया गया था. अंग्रेजी संस्करण प्रामाणिक है.
#
कक्षा

वास्तविक समय सेवा

संपत्तिविवरण
get connectionState(): ConnectionStateवर्तमान कनेक्शन स्थिति.
get isConnected(): booleanक्या वेबसॉकेट वर्तमान में कनेक्ट है।
तरीकाविवरण
onStateChange(callback: (state: ConnectionState) => void): () => voidकनेक्शन स्थिति परिवर्तन सुनें.
onError(callback: (err: RealtimeConnectionError) => void): () => voidरीयलटाइम कनेक्शन ट्रांसपोर्ट त्रुटियों को सुनें।
connect(): voidसुनिश्चित करें कि वेबसॉकेट कनेक्शन खुला है।
refreshToken(token: string): voidमौजूदा कनेक्शन पर JWT टोकन को रीफ्रेश करें (कोई डिस्कनेक्ट नहीं)।
setAuth(token?: string): voidनिजी और प्रसारण चैनलों के प्राधिकरण के लिए उपयोग किए जाने वाले टोकन को स्पष्ट रूप से परिभाषित/ताज़ा करता है (समता @supabase/realtime-js setAuth)।
httpBroadcast(channel: string, event: string, payload?: Record<string, unknown>, options?: HttpBroadcastOptions): Promise<AuraResponse<null>>खुले वेबसॉकेट कनेक्शन (समता @supabase/realtime-js) के बिना, HTTP (REST) ​​के माध्यम से प्रसारण भेजता है।
setAutoReconnect(enabled: boolean, maxAttempts?: number): voidऑटो-रीकनेक्ट सक्षम/अक्षम करें (डिफ़ॉल्ट रूप से सक्षम)।
disconnect(): voidवेबसॉकेट को डिस्कनेक्ट करें और सभी चैनल साफ़ करें।
channel(name: string, options?: ChannelConfig): AuraChannelनाम से एक चैनल बनाएं या पुनः प्राप्त करें।
removeChannel(channel: string | AuraChannel): voidकिसी चैनल को नाम से या AuraChannel उदाहरण से हटाएँ।
getChannels(): AuraChannel[]सक्रिय चैनलों की सूची बनाएं.
removeAllChannels(): voidसभी चैनल और सदस्यताएँ हटाएँ.
#
कक्षा

ऑराचैनल

Supabase-संगत श्रृंखला योग्य एपीआई वाला एक रीयलटाइम चैनल।

संपत्तिविवरण
readonly name: stringचैनल का नाम realtime.channel(name) को दिया गया।
get fullName(): stringप्रोजेक्ट उपसर्ग के साथ पूरा चैनल नाम (सर्वर प्रोटोकॉल के लिए)
get isSubscribed(): booleanक्या इस चैनल को सब्सक्राइब किया गया है.
तरीकाविवरण
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 फ़िल्टरिंग के साथ PostgreSQL (CDC) इवेंट के लिए श्रोता को पंजीकृत करता है।
off(type?: RealtimeListenType, filter?: PostgresChangesFilter | BroadcastFilter | PresenceFilter, callback?: (payload: unknown) => void): thisचैनल को बंद किए बिना या वेबसॉकेट को काटे बिना एक या अधिक श्रोताओं को चैनल से हटा देता है।
subscribe(callback?: SubscribeCallback, timeoutMs?: number): thisचैनल को सब्सक्राइब करें.
unsubscribe(): voidचैनल से सदस्यता समाप्त करें.
send(message: BroadcastPayload): Promise<BroadcastSendStatus>चैनल पर एक प्रसारण संदेश भेजता है.
track(state: Record<string, unknown>): Promise<'ok' | 'error'>इस क्लाइंट के लिए उपस्थिति स्थिति ट्रैक करें.
untrack(): Promise<'ok' | 'error'>उपस्थिति पर नज़र रखना बंद करें.
presenceState(): PresenceStateइस चैनल के लिए वर्तमान उपस्थिति स्थिति प्राप्त करें.
जनरेट किया गया पेज

यह पृष्ठ एसडीके की प्रकार की घोषणाओं और टिप्पणियों से उत्पन्न हुआ है, इसलिए यह प्रकाशित कोड से अलग नहीं हो सकता है। कारगर उदाहरणों के लिए, मार्गदर्शिकाएँ पढ़ें।