UseCollectionOptions

__type(result: CollectionFetcherResult<T>): void | CollectionFetcherResult<T> | Promise<undefined | CollectionFetcherResult<T>>

Properties

This element is often used without passing props

Additional properties for advanced use cases

Properties	Type	Description
active	T[]
adapter	ItemAdapter<T>
auth	boolean | AnonymousObject<any>
autoload	boolean
body	null | BodyInit	A BodyInit object or null to set request's body.
brokerable	boolean
cache	RequestCache	A string indicating how the request will interact with the browser's cache to set request's cache.
comparator	QuerySortComparator<T>
comparators	AnonymousObject<QuerySortComparator<T>>
credentials	RequestCredentials	A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.
dataKey	string
delayLoading	number
disabled	T[]
fetcher	CollectionFetcher<T>
fetchOnce	boolean
hasMoreKey	string
headers	HeadersInit	A Headers object, an object literal, or an array of two-item arrays to set request's headers.
highlighted	T[]
initialFields	string[]
initialFilter	QueryFilter | QueryFilterCriteria | QueryFilterOrCriteria[]
initialLimit	number
initialOffset	number
initialParams	AnonymousObject<any>
initialSearch	Primitive
initialSort	QuerySortDir
initialSortBy	string | QuerySortBy | QuerySortBy[]
integrity	string	A cryptographic hash of the resource to be fetched by request. Sets request's integrity.
keepalive	boolean	A boolean to set request's keepalive.
method	HttpMethod
mode	RequestMode	A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.
mutateUrl	boolean
onFetchError	ErrorCallback
onFetchSuccess
params	AnonymousObject<string>
query	AnonymousObject<string>
queryEngine	QueryEngine<T, I>
redirect	RequestRedirect	A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.
referrer	string	A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.
referrerPolicy	ReferrerPolicy	A referrer policy to set request's referrerPolicy.
searcher	QuerySearcher<T>
selected	T[]
serializer	QuerySerializer
signal	null | AbortSignal	An AbortSignal to set request's signal.
throttle	number
totalKey	string
window	null	Can only be null. Used to disassociate request from any Window.