Interface: BaseConvexClientOptions

browser.BaseConvexClientOptions

Options for BaseConvexClient.

Hierarchy

• BaseConvexClientOptions

  ↳ ConvexReactClientOptions

Properties

unsavedChangesWarning

• Optional unsavedChangesWarning: boolean

Whether to prompt the user if they have unsaved changes pending when navigating away or closing a web page.

This is only possible when the window object exists, i.e. in a browser.

The default value is true in browsers.

Defined in

browser/sync/client.ts:56

---

webSocketConstructor

• Optional webSocketConstructor: Object

Call signature

• new webSocketConstructor(url, protocols?): WebSocket

Specifies an alternate WebSocket constructor to use for client communication with the Convex cloud. The default behavior is to use WebSocket from the global environment.

Parameters

Name	Type
url	string | URL
protocols?	string | string[]

Returns

WebSocket

Type declaration

Name	Type
prototype	WebSocket
CONNECTING	0
OPEN	1
CLOSING	2
CLOSED	3

Defined in

browser/sync/client.ts:63

---

verbose

• Optional verbose: boolean

Adds additional logging for debugging purposes.

The default value is false.

Defined in

browser/sync/client.ts:69

---

reportDebugInfoToConvex

• Optional reportDebugInfoToConvex: boolean

Sends additional metrics to Convex for debugging purposes.

The default value is false.

Defined in

browser/sync/client.ts:75