rxdb
Version:
A local-first realtime NoSQL Database for JavaScript applications - https://rxdb.info/
12 lines (11 loc) • 893 B
TypeScript
import { UseRxQueryOptions, UseRxQueryResult } from './use-rx-query.ts';
/**
* React hook to query an RxDB collection with Mango queries.
*
* @param {UseRxQueryOptions<RxDocumentType, OrmMethods, StaticMethods, InstanceCreationOptions, Reactivity>} options - Options for the query.
* @param {string|RxCollection} options.collection - The collection name or instance to query.
* @param {MangoQuery<RxDocumentType>} options.query - The Mango query to execute.
*
* @returns {UseRxQueryResult<RxDocumentType, OrmMethods>} The query result, loading state, and error.
*/
export declare function useLiveRxQuery<RxDocumentType = any, OrmMethods = {}, StaticMethods = {}, InstanceCreationOptions = {}, Reactivity = unknown>({ collection, query, }: UseRxQueryOptions<RxDocumentType, OrmMethods, StaticMethods, InstanceCreationOptions, Reactivity>): UseRxQueryResult<RxDocumentType, OrmMethods>;