dartvex library
Pure Dart client APIs for communicating with a Convex deployment.
Classes
-
AuthAuthenticated<
TUser> - Authentication state for a signed-in user.
- AuthHandle
-
Handle returned by
AuthManager.setAuthWithRefreshto stop token refreshes. -
AuthLoading<
TUser> - Authentication state used while a login or refresh is in progress.
-
AuthProvider<
TUser> - Adapter interface used by ConvexClient.withAuth for external auth systems.
-
AuthState<
TUser> - Base class for authentication state exposed by ConvexAuthClient.
-
AuthUnauthenticated<
TUser> - Authentication state for a signed-out user.
-
ConvexAuthClient<
TUser> - Convex client interface extended with authentication lifecycle APIs.
- ConvexClient
- Main Dartvex client for communicating with a Convex deployment.
- ConvexClientConfig
- Configuration for a ConvexClient connection.
-
ConvexClientWithAuth<
TUser> - Wraps a ConvexClient with auth-provider-driven login and token refresh.
- ConvexFunctionCaller
- Interface for calling Convex queries, mutations, and actions.
- ConvexStorage
- Helper for uploading and downloading files via Convex storage.
- ConvexSubscription
- Handle for a live Convex query subscription.
- DartvexLogEvent
- Structured log event emitted by Dartvex.
- QueryError
- Query result representing an error.
- QueryResult
- Base class for query subscription results.
- QuerySuccess
- Query result representing a successful value.
- TransitionMetrics
- Performance metrics for a received Transition message.
Enums
- ConnectionState
- High-level connection state exposed by ConvexClient.
- DartvexLogLevel
- Log levels supported by Dartvex structured logging.
Typedefs
- DartvexLogger = void Function(DartvexLogEvent event)
- Callback used to receive Dartvex log events.
- TransitionMetricsCallback = void Function(TransitionMetrics metrics)
- Callback type for transition performance monitoring.
Exceptions / Errors
- ConvexException
- Exception thrown when a Convex request or protocol operation fails.
- ConvexFileUploadException
- Exception thrown when a file upload to Convex storage fails.