API Reference
useConvexQueries
Reference for subscribing to multiple reactive Convex queries at once.
useConvexQueries manages a record of query subscriptions and keeps them in sync as the record changes.
Import
Nuxt
const { data, errors } = useConvexQueries(queries)
Vue
import { useConvexQueries } from 'vue-convex'
Signature
interface QueryEntry<Query extends FunctionReference<'query'> = FunctionReference<'query'>> {
query: Query
args: FunctionArgs<Query> | 'skip'
}
function useConvexQueries<T extends Record<string, QueryEntry>>(
queries: MaybeRefOrGetter<T>,
): {
data: Readonly<Ref<{ [K in keyof T]?: FunctionReturnType<T[K]['query']> }>>
errors: Readonly<Ref<Record<string, Error | null>>>
}
Behavior
- Adds, removes, and updates subscriptions as the input record changes
- Supports
"skip"per entry - Cleans up subscriptions automatically on scope disposal