Interface: FrappeRealtime
Defined in: packages/client/src/realtime/types.ts:94
Stable
Properties
connected
readonlyconnected:boolean
Defined in: packages/client/src/realtime/types.ts:96
Whether the underlying socket is currently connected.
Methods
close()
close():
void
Defined in: packages/client/src/realtime/types.ts:102
Disconnects and releases all subscriptions and listeners. Safe to call more than once.
Returns
void
connect()
connect():
Promise<void>
Defined in: packages/client/src/realtime/types.ts:99
Connects, if not already connecting/connected. Resolves once the socket has connected (or rejects on connect_error).
Returns
Promise<void>
on()
on<
K>(event,handler):Unsubscribe
Defined in: packages/client/src/realtime/types.ts:114
Subscribes to a raw connection-lifecycle event (connect, disconnect, reconnect, ...). Returns an unsubscribe function.
Type Parameters
K
K extends keyof RealtimeConnectionEventMap
Parameters
event
K
handler
(payload) => void
Returns
subscribeDoc()
subscribeDoc(
doctype,name,handler):Unsubscribe
Defined in: packages/client/src/realtime/types.ts:105
Subscribes to doc_update events for one document. Returns an unsubscribe function.
Parameters
doctype
string
name
string
handler
(event) => void
Returns
subscribeDocType()
subscribeDocType(
doctype,handler):Unsubscribe
Defined in: packages/client/src/realtime/types.ts:108
Subscribes to list_update events for a doctype (any document of that type changing). Returns an unsubscribe function.
Parameters
doctype
string
handler
(event) => void
Returns
subscribeDocViewers()
subscribeDocViewers(
doctype,name,handler):Unsubscribe
Defined in: packages/client/src/realtime/types.ts:111
Subscribes to doc_viewers presence events for one document. Returns an unsubscribe function.
Parameters
doctype
string
name
string
handler
(event) => void