Skip to main content

Interface: RealtimeOptions

Defined in: packages/client/src/realtime/types.ts:59

Properties​

allowCrossOriginCredentials?​

optional allowCrossOriginCredentials?: boolean

Defined in: packages/client/src/realtime/types.ts:67

Allow HTTP client cookies/authorization to be sent to a different socket origin. Default false.

auth?​

optional auth?: Record<string, unknown> | ((ctx) => Record<string, unknown> | Promise<Record<string, unknown>>)

Defined in: packages/client/src/realtime/types.ts:82

Extra socket.handshake.auth payload, merged over the client's derived auth context ({ cookie, authorization }). Use this for setups with a custom realtime auth scheme.

autoConnect?​

optional autoConnect?: boolean

Defined in: packages/client/src/realtime/types.ts:88

Connect immediately on creation. Default true. Set false to call .connect() yourself.

path?​

optional path?: string

Defined in: packages/client/src/realtime/types.ts:69

Socket.IO path. Default /socket.io.

reconnection?​

optional reconnection?: boolean

Defined in: packages/client/src/realtime/types.ts:71

Default true.

reconnectionAttempts?​

optional reconnectionAttempts?: number

Defined in: packages/client/src/realtime/types.ts:73

Default Infinity — matches Frappe's own socketio_client.js.

reconnectionDelay?​

optional reconnectionDelay?: number

Defined in: packages/client/src/realtime/types.ts:75

Default 1000 ms.

reconnectionDelayMax?​

optional reconnectionDelayMax?: number

Defined in: packages/client/src/realtime/types.ts:77

Default 5000 ms.

socketUrl?​

optional socketUrl?: string

Defined in: packages/client/src/realtime/types.ts:65

Socket.IO server URL. Defaults to the FrappeClient's config.baseUrl — correct for setups that proxy /socket.io on the same origin as the site (the default Frappe bench/nginx layout). Override for a dedicated realtime host/port.

transports?​

optional transports?: string[]

Defined in: packages/client/src/realtime/types.ts:86

Transports to try, in order. Default ['websocket', 'polling'].