Skip to main content

Interface: CollectionState<T, M>

Type parameters​

NameType
TT
Mextends ItemMeta

Hierarchy​

Properties​

adapter​

• Optional adapter: CollectionItemAdapter<T, M>

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:106


autoload​

• Optional autoload: boolean

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:107


comparator​

• Optional comparator: QuerySortComparator

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:108


comparators​

• Optional comparators: AnonymousObject<QuerySortComparator>

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:109


dataKey​

• dataKey: string

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:110


db​

• Optional db: Item<T, M>[]

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:111


error​

• Optional error: BasicError

Inherited from​

FetchState.error

Defined in​

onekijs/packages/onekijs-framework/src/types/fetch.ts:11


fetchOnce​

• Optional fetchOnce: boolean

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:112


fetchOptions​

• Optional fetchOptions: FetchOptions<CollectionFetcherResult<T>, undefined | Query>

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:113


fetching​

• Optional fetching: boolean

Inherited from​

FetchState.fetching

Defined in​

onekijs/packages/onekijs-framework/src/types/fetch.ts:9


fields​

• Optional fields: string[]

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:114


filter​

• Optional filter: QueryFilter | QueryFilterCriteria | QueryFilterOrCriteria[]

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:115


hasMore​

• Optional hasMore: boolean

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:116


hasMoreKey​

• hasMoreKey: string

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:117


items​

• Optional items: (undefined | Item<T, M>)[]

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:118


limit​

• Optional limit: number

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:121


loading​

• Optional loading: boolean

Inherited from​

FetchState.loading

Defined in​

onekijs/packages/onekijs-framework/src/types/fetch.ts:8


local​

• local: boolean

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:120


method​

• Optional method: HttpMethod

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:119


offset​

• Optional offset: number

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:122


params​

• Optional params: AnonymousObject<any>

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:123


queryEngine​

• Optional queryEngine: QueryEngine<T, M>

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:124


result​

• Optional result: any

Inherited from​

FetchState.result

Defined in​

onekijs/packages/onekijs-framework/src/types/fetch.ts:10


router​

• router: Router

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:125


• Optional search: Primitive

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:126


searcher​

• Optional searcher: QuerySearcher<T>

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:127


serializer​

• Optional serializer: QuerySerializer

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:128


sort​

• Optional sort: QuerySortDir

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:129


sortBy​

• Optional sortBy: string | QuerySortBy | QuerySortBy[]

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:130


status​

• Optional status: CollectionStatus

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:131


task​

• Optional task: Task

Inherited from​

FetchState.task

Defined in​

onekijs/packages/onekijs-framework/src/types/fetch.ts:12


throttle​

• Optional throttle: number

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:132


total​

• Optional total: number

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:133


totalKey​

• totalKey: string

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:134


url​

• Optional url: string

Defined in​

onekijs/packages/onekijs-framework/src/collection/typings.ts:135