Module: browser
Tools for accessing Convex in the browser.
If you are using React, use the react module instead.
Usage
Create a ConvexHttpClient to connect to the Convex Cloud.
import { ConvexHttpClient } from "convex/browser";
// typically loaded from an environment variable
const address = "https://small-mouse-123.convex.cloud";
const convex = new ConvexHttpClient(address);
Classes
Interfaces
Type Aliases
HttpMutationOptions
Ƭ HttpMutationOptions: Object
Type declaration
| Name | Type | Description |
|---|---|---|
skipQueue | boolean | Skip the default queue of mutations and run this immediately. This allows the same HttpConvexClient to be used to request multiple mutations in parallel, something not possible with WebSocket-based clients. |
Defined in
ConvexClientOptions
Ƭ ConvexClientOptions: BaseConvexClientOptions & { disabled?: boolean ; unsavedChangesWarning?: boolean }
Defined in
AuthTokenFetcher
Ƭ AuthTokenFetcher: (args: { forceRefreshToken: boolean }) => Promise<string | null | undefined>
Type declaration
▸ (args): Promise<string | null | undefined>
An async function returning a JWT. Depending on the auth providers configured in convex/auth.config.ts, this may be a JWT-encoded OpenID Connect Identity Token or a traditional JWT.
forceRefreshToken is true if the server rejected a previously
returned token or the token is anticipated to expiring soon
based on its exp time.
See ConvexReactClient.setAuth.
Parameters
| Name | Type |
|---|---|
args | Object |
args.forceRefreshToken | boolean |
Returns
Promise<string | null | undefined>
Defined in
browser/sync/authentication_manager.ts:25
ConnectionState
Ƭ ConnectionState: Object
State describing the client's connection with the Convex backend.
Type declaration
| Name | Type | Description |
|---|---|---|
hasInflightRequests | boolean | - |
isWebSocketConnected | boolean | - |
timeOfOldestInflightRequest | Date | null | - |
hasEverConnected | boolean | True if the client has ever opened a WebSocket to the "ready" state. |
connectionCount | number | The number of times this client has connected to the Convex backend. A number of things can cause the client to reconnect -- server errors, bad internet, auth expiring. But this number being high is an indication that the client is having trouble keeping a stable connection. |
connectionRetries | number | The number of times this client has tried (and failed) to connect to the Convex backend. |
inflightMutations | number | The number of mutations currently in flight. |
inflightActions | number | The number of actions currently in flight. |
Defined in
FunctionResult
Ƭ FunctionResult: FunctionSuccess | FunctionFailure
The result of running a function on the server.
If the function hit an exception it will have an errorMessage. Otherwise
it will produce a Value.
Defined in
browser/sync/function_result.ts:11
OptimisticUpdate
Ƭ OptimisticUpdate<Args>: (localQueryStore: OptimisticLocalStore, args: Args) => void
Type parameters
| Name | Type |
|---|---|
Args | extends Record<string, Value> |
Type declaration
▸ (localQueryStore, args): void
A temporary, local update to query results within this client.
This update will always be executed when a mutation is synced to the Convex server and rolled back when the mutation completes.
Note that optimistic updates can be called multiple times! If the client loads new data while the mutation is in progress, the update will be replayed again.
Parameters
| Name | Type | Description |
|---|---|---|
localQueryStore | OptimisticLocalStore | An interface to read and edit local query results. |
args | Args | The arguments to the mutation. |
Returns
void
Defined in
browser/sync/optimistic_updates.ts:90
PaginationStatus
Ƭ PaginationStatus: "LoadingFirstPage" | "CanLoadMore" | "LoadingMore" | "Exhausted"
Defined in
QueryJournal
Ƭ QueryJournal: string | null
A serialized representation of decisions made during a query's execution.
A journal is produced when a query function first executes and is re-used when a query is re-executed.
Currently this is used to store pagination end cursors to ensure that pages of paginated queries will always end at the same cursor. This enables gapless, reactive pagination.
null is used to represent empty journals.
Defined in
QueryToken
Ƭ QueryToken: string & { __queryToken: true }
A string representing the name and arguments of a query.
This is used by the BaseConvexClient.
Defined in
browser/sync/udf_path_utils.ts:31
PaginatedQueryToken
Ƭ PaginatedQueryToken: QueryToken & { __paginatedQueryToken: true }
A string representing the name and arguments of a paginated query.
This is a specialized form of QueryToken used for paginated queries.
Defined in
browser/sync/udf_path_utils.ts:38
UserIdentityAttributes
Ƭ UserIdentityAttributes: Omit<UserIdentity, "tokenIdentifier">