InfiniteQueryOptions<TPage, TPageParam> class final

A typed infinite query definition backed by the ordinary Query runtime.

Constructors

InfiniteQueryOptions({required QueryKey<InfiniteData<TPage, TPageParam>> key, required InfinitePageFunction<TPage, TPageParam> query, required TPageParam initialPageParam, required InfiniteNextPage<TPage, TPageParam> getNextPageParam, InfinitePreviousPage<TPage, TPageParam>? getPreviousPageParam, int? maxPages, QueryPolicy policy = const QueryPolicy(), Map<String, Object?> meta = const <String, Object?>{}})
Creates an infinite query definition.

Properties

getNextPageParam → InfiniteNextPage<TPage, TPageParam>
Selects the next page parameter.
final
getPreviousPageParam → InfinitePreviousPage<TPage, TPageParam>?
Selects the previous page parameter, when backward paging is supported.
final
hashCode → int
The hash code for this object.
no setterinherited
initialPageParam → TPageParam
The parameter used for the first page.
final
key → QueryKey<InfiniteData<TPage, TPageParam>>
The cache key shared by all pages.
final
maxPages → int?
Maximum retained pages, or null for no limit.
final
meta → Map<String, Object?>
User metadata passed to each page fetch.
final
policy → QueryPolicy
Query runtime policy for page fetching.
final
query → InfinitePageFunction<TPage, TPageParam>
Fetches one page.
final
queryOptions → QueryOptions<InfiniteData<TPage, TPageParam>>
The ordinary query definition used to store this infinite query.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

hasNextPage(InfiniteData<TPage, TPageParam>? data) → bool
Whether data provides another forward page parameter.
hasPreviousPage(InfiniteData<TPage, TPageParam>? data) → bool
Whether data provides another backward page parameter.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited