injectLiveQuery

Call Signature

function injectLiveQuery<TContext, TParams>(options): InjectLiveQueryResult<TContext>;

Defined in: index.ts:118

Type Parameters

TContext

TContext extends Context

TParams

TParams extends unknown

Parameters

options

params

() => TParams

query

(args) => QueryBuilder<TContext>

Returns

InjectLiveQueryResult<TContext>

Call Signature

function injectLiveQuery<TContext, TParams>(options): InjectConditionalLiveQueryResult<TContext>;

Defined in: index.ts:128

Type Parameters

TContext

TContext extends Context

TParams

TParams extends unknown

Parameters

options

params

() => TParams

query

(args) => QueryBuilder<TContext> | null | undefined

Returns

InjectConditionalLiveQueryResult<TContext>

Call Signature

function injectLiveQuery<TContext>(queryFn): InjectLiveQueryResult<TContext>;

Defined in: index.ts:138

Type Parameters

TContext

TContext extends Context

Parameters

queryFn

(q) => QueryBuilder<TContext>

Returns

InjectLiveQueryResult<TContext>

Call Signature

function injectLiveQuery<TContext>(queryFn): InjectConditionalLiveQueryResult<TContext>;

Defined in: index.ts:141

Type Parameters

TContext

TContext extends Context

Parameters

queryFn

(q) => QueryBuilder<TContext> | null | undefined

Returns

InjectConditionalLiveQueryResult<TContext>

Call Signature

function injectLiveQuery<TContext>(config): InjectLiveQueryResult<TContext>;

Defined in: index.ts:146

Type Parameters

TContext

TContext extends Context

Parameters

config

LiveQueryCollectionConfig<TContext>

Returns

InjectLiveQueryResult<TContext>

Call Signature

function injectLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): InjectLiveQueryResultWithCollection<TResult, TKey, TUtils>;

Defined in: index.ts:150

Type Parameters

TResult

TResult extends object

TKey

TKey extends string | number

TUtils

TUtils extends Record<string, any>

Parameters

liveQueryCollection

Collection<TResult, TKey, TUtils, StandardSchemaV1<unknown, unknown>, TResult> & NonSingleResult

Returns

InjectLiveQueryResultWithCollection<TResult, TKey, TUtils>

Call Signature

function injectLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): InjectLiveQueryResultWithSingleResultCollection<TResult, TKey, TUtils>;

Defined in: index.ts:158

Type Parameters

TResult

TResult extends object

TKey

TKey extends string | number

TUtils

TUtils extends Record<string, any>

Parameters

liveQueryCollection

Collection<TResult, TKey, TUtils, StandardSchemaV1<unknown, unknown>, TResult> & SingleResult

Returns

InjectLiveQueryResultWithSingleResultCollection<TResult, TKey, TUtils>