Interface: ConvexReactClientOptions
react.ConvexReactClientOptions
Options for ConvexReactClient.
Hierarchy
-
↳
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.
Inherited from
BaseConvexClientOptions.unsavedChangesWarning
Defined in
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 |
Inherited from
BaseConvexClientOptions.webSocketConstructor
Defined in
verbose
• Optional verbose: boolean
Adds additional logging for debugging purposes.
The default value is false.
Inherited from
BaseConvexClientOptions.verbose
Defined in
logger
• Optional logger: Logger
A logger. If not provided, logs to the console.
You can construct your own logger to customize logging to log elsewhere or not log at all.
Inherited from
BaseConvexClientOptions.logger
Defined in
reportDebugInfoToConvex
• Optional reportDebugInfoToConvex: boolean
Sends additional metrics to Convex for debugging purposes.
The default value is false.
Inherited from
BaseConvexClientOptions.reportDebugInfoToConvex
Defined in
skipConvexDeploymentUrlCheck
• Optional skipConvexDeploymentUrlCheck: boolean
Skip validating that the Convex deployment URL looks like
https://happy-animal-123.convex.cloud or localhost.
This can be useful if running a self-hosted Convex backend that uses a different URL.
The default value is false
Inherited from
BaseConvexClientOptions.skipConvexDeploymentUrlCheck
Defined in
authRefreshTokenLeewaySeconds
• Optional authRefreshTokenLeewaySeconds: number
If using auth, the number of seconds before a token expires that we should refresh it.
The default value is 2.
Inherited from
BaseConvexClientOptions.authRefreshTokenLeewaySeconds