useLiveInfiniteQuery

Call Signature#

function useLiveInfiniteQuery<TResult, TKey, TUtils>(liveQueryCollection, config): UseLiveInfiniteQueryReturnWithCollection<TResult, TKey, TUtils>;

Defined in: useLiveInfiniteQuery.ts:86

Page through an ordered live query, growing one live-query Collection's window with utils.setWindow() instead of recreating it per page.

The query must include .orderBy(). Its identity follows useLiveQuery: derived from the query IR, or named by queryKey. A query whose IR cannot be hashed throws UnhashableQueryIRError unless queryKey is supplied.

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

config#

UseLiveInfiniteQueryConfig<any>

Returns#

UseLiveInfiniteQueryReturnWithCollection<TResult, TKey, TUtils>

Example#

const { pages, fetchNextPage, hasNextPage } = useLiveInfiniteQuery(
  (q) =>
    q
      .from({ posts: postsCollection })
      .orderBy(({ posts }) => posts.createdAt, `desc`),
  { pageSize: 20 },
)

Call Signature#

function useLiveInfiniteQuery<TContext>(queryFn, config): UseLiveInfiniteQueryReturn<TContext>;

Defined in: useLiveInfiniteQuery.ts:95

Page through an ordered live query, growing one live-query Collection's window with utils.setWindow() instead of recreating it per page.

The query must include .orderBy(). Its identity follows useLiveQuery: derived from the query IR, or named by queryKey. A query whose IR cannot be hashed throws UnhashableQueryIRError unless queryKey is supplied.

Type Parameters#

TContext#

TContext extends Context

Parameters#

queryFn#

(q) => QueryBuilder<TContext>

config#

UseLiveInfiniteQueryConfig<TContext>

Returns#

UseLiveInfiniteQueryReturn<TContext>

Example#

const { pages, fetchNextPage, hasNextPage } = useLiveInfiniteQuery(
  (q) =>
    q
      .from({ posts: postsCollection })
      .orderBy(({ posts }) => posts.createdAt, `desc`),
  { pageSize: 20 },
)