API Reference

injectLiveQuery

Function: injectLiveQuery()

Call Signature

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

Defined in: index.ts:89

Type Parameters

TContext

TContext extends Context

TParams

TParams extends unknown

Parameters

options

params

() => TParams

query

(args) => QueryBuilder\<`TContext`\>

Returns

InjectLiveQueryResult\<`TContext`\>

Call Signature

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

Defined in: index.ts:99

Type Parameters

TContext

TContext extends Context

TParams

TParams extends unknown

Parameters

options

params

() => TParams

query

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

Returns

InjectLiveQueryResult\<`TContext`\>

Call Signature

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

Defined in: index.ts:109

Type Parameters

TContext

TContext extends Context

Parameters

queryFn

(q) => QueryBuilder\<`TContext`\>

Returns

InjectLiveQueryResult\<`TContext`\>

Call Signature

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

Defined in: index.ts:112

Type Parameters

TContext

TContext extends Context

Parameters

queryFn

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

Returns

InjectLiveQueryResult\<`TContext`\>

Call Signature

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

Defined in: index.ts:117

Type Parameters

TContext

TContext extends Context

Parameters

config

LiveQueryCollectionConfig\<`TContext`\>

Returns

InjectLiveQueryResult\<`TContext`\>

Call Signature

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

Defined in: index.ts:121

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

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

Defined in: index.ts:129

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`\>