Interface: UseCollectionOptions<T, M>
Type parameters
| Name | Type |
|---|---|
T | T |
M | extends ItemMeta |
Hierarchy
CollectionOptions<T,M>CollectionFetchOptions<CollectionFetcherResult<T>,Query|undefined>↳
UseCollectionOptions
Properties
adapter
• Optional adapter: CollectionItemAdapter<T, M>
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:80
auth
• Optional auth: boolean | AnonymousObject<any>
Inherited from
CollectionFetchOptions.auth
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:74
autoload
• Optional autoload: boolean
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:81
body
• Optional body: null | BodyInit
A BodyInit object or null to set request's body.
Inherited from
CollectionFetchOptions.body
Defined in
oneki.github.io/node_modules/typescript/lib/lib.dom.d.ts:1595
cache
• Optional cache: RequestCache
A string indicating how the request will interact with the browser's cache to set request's cache.
Inherited from
CollectionFetchOptions.cache
Defined in
oneki.github.io/node_modules/typescript/lib/lib.dom.d.ts:1599
comparator
• Optional comparator: QuerySortComparator
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:82
comparators
• Optional comparators: AnonymousObject<QuerySortComparator>
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:83
credentials
• Optional 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.
Inherited from
CollectionFetchOptions.credentials
Defined in
oneki.github.io/node_modules/typescript/lib/lib.dom.d.ts:1603
dataKey
• Optional dataKey: string
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:84
delayLoading
• Optional delayLoading: number
Inherited from
CollectionFetchOptions.delayLoading
Defined in
onekijs/packages/onekijs-framework/src/types/fetch.ts:35
fetchOnce
• Optional fetchOnce: boolean
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:86
fetcher
• Optional fetcher: CollectionFetcher<T>
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:85
hasMoreKey
• Optional hasMoreKey: string
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:87
headers
• Optional headers: AnonymousObject<string>
Inherited from
CollectionFetchOptions.headers
Defined in
onekijs/packages/onekijs-framework/src/types/fetch.ts:37
initialFields
• Optional initialFields: string[]
Inherited from
CollectionOptions.initialFields
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:88
initialFilter
• Optional initialFilter: QueryFilter | QueryFilterCriteria | QueryFilterOrCriteria[]
Inherited from
CollectionOptions.initialFilter
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:89
initialLimit
• Optional initialLimit: number
Inherited from
CollectionOptions.initialLimit
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:90
initialOffset
• Optional initialOffset: number
Inherited from
CollectionOptions.initialOffset
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:91
initialParams
• Optional initialParams: AnonymousObject<any>
Inherited from
CollectionOptions.initialParams
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:92
initialSearch
• Optional initialSearch: Primitive
Inherited from
CollectionOptions.initialSearch
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:93
initialSort
• Optional initialSort: QuerySortDir
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:94
initialSortBy
• Optional initialSortBy: string | QuerySortBy | QuerySortBy[]
Inherited from
CollectionOptions.initialSortBy
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:95
integrity
• Optional integrity: string
A cryptographic hash of the resource to be fetched by request. Sets request's integrity.
Inherited from
CollectionFetchOptions.integrity
Defined in
oneki.github.io/node_modules/typescript/lib/lib.dom.d.ts:1611
keepalive
• Optional keepalive: boolean
A boolean to set request's keepalive.
Inherited from
CollectionFetchOptions.keepalive
Defined in
oneki.github.io/node_modules/typescript/lib/lib.dom.d.ts:1615
method
• Optional method: HttpMethod
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:96
mode
• Optional mode: RequestMode
A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.
Inherited from
CollectionFetchOptions.mode
Defined in
oneki.github.io/node_modules/typescript/lib/lib.dom.d.ts:1623
mutateUrl
• Optional mutateUrl: boolean
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:97
onError
• Optional onError: ErrorCallback<BasicError>
Inherited from
CollectionFetchOptions.onError
Defined in
onekijs/packages/onekijs-framework/src/types/fetch.ts:33
onSuccess
• Optional onSuccess: SuccessCallback<CollectionFetcherResult<T>>
Inherited from
CollectionFetchOptions.onSuccess
Defined in
onekijs/packages/onekijs-framework/src/types/fetch.ts:34
params
• Optional params: AnonymousObject<string>
Inherited from
CollectionFetchOptions.params
Defined in
onekijs/packages/onekijs-framework/src/types/fetch.ts:38
query
• Optional query: AnonymousObject<string>
Inherited from
CollectionFetchOptions.query
Defined in
onekijs/packages/onekijs-framework/src/types/fetch.ts:39
queryEngine
• Optional queryEngine: QueryEngine<T, M>
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:98
redirect
• Optional 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.
Inherited from
CollectionFetchOptions.redirect
Defined in
oneki.github.io/node_modules/typescript/lib/lib.dom.d.ts:1627
referrer
• Optional referrer: string
A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.
Inherited from
CollectionFetchOptions.referrer
Defined in
oneki.github.io/node_modules/typescript/lib/lib.dom.d.ts:1631
referrerPolicy
• Optional referrerPolicy: ReferrerPolicy
A referrer policy to set request's referrerPolicy.
Inherited from
CollectionFetchOptions.referrerPolicy
Defined in
oneki.github.io/node_modules/typescript/lib/lib.dom.d.ts:1635
searcher
• Optional searcher: QuerySearcher<T>
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:99
serializer
• Optional serializer: QuerySerializer
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:100
signal
• Optional signal: null | AbortSignal
An AbortSignal to set request's signal.
Inherited from
CollectionFetchOptions.signal
Defined in
oneki.github.io/node_modules/typescript/lib/lib.dom.d.ts:1639
throttle
• Optional throttle: number
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:101
totalKey
• Optional totalKey: string
Inherited from
Defined in
onekijs/packages/onekijs-framework/src/collection/typings.ts:102
window
• Optional window: any
Can only be null. Used to disassociate request from any Window.
Inherited from
CollectionFetchOptions.window
Defined in
oneki.github.io/node_modules/typescript/lib/lib.dom.d.ts:1643