t×tecexpressby TeKOcloud
DEv0.7.1
API & types / VUE

TxDataSourceConfig.

Configuration for the store, keys, query, paging and local or remote processing.

ts
interface TxDataSourceConfig<T> extends Omit<
  TxLoadOptions<T>,
  'skip' | 'take' | 'signal'
> {
  store: TxStore<T> | T[]
  key?: TxSelector<T>
  pageSize?: number
  pageIndex?: number
  paginate?: boolean
  remoteOperations?: boolean
  map?: (item: T) => T
}
FieldMeaning
storeData collection or custom store contract.
keyStable key or selector; distinct from a widget key.
pageSizeRecords per page.
pageIndexZero-based page index.
paginateEnables paging; false loads the whole collection.
remoteOperationsStore handles queries itself; automatically enabled for custom stores.
mapTransformation of each loaded visible record.
sortSort descriptors in priority order.
filterFilter expression.
searchExprSearch fields or getters.
searchValueSearch text; local search ignores case.
groupGroup descriptors or group name.
selectProjection before final mapping.
requireTotalCountRequests the total count before paging.
requireGroupCountRequests the number of top-level groups.
ts
import type { TxDataSourceConfig } from '@tekocloud.de/tecexpress'
const example: TxDataSourceConfig<{ id: number }> = { store: [{ id: 1 }], key: 'id', pageSize: 10 }
console.log(example)