Interface ISortableDatasource<T>

A datasource that supports server-side or in-memory sorting.

interface ISortableDatasource<T = unknown> {
    getNumberOfItems(): number | Promise<number>;
    getObjectAtRowIndex(rowIndex: number): RowResult<T>;
    sortBy(expression: SortExpression<T> | null): void;
}

Type Parameters

T = unknown
The row object type.

Hierarchy (View Summary)

IDatasource<T>
- ISortableDatasource

Implemented by

SortableArrayDatasource

Index

Methods

getNumberOfItems getObjectAtRowIndex sortBy

Methods

getNumberOfItems

getNumberOfItems(): number | Promise<number>
Returns the total number of items, synchronously or asynchronously.

Returns number | Promise<number>
Inherited from IDatasource.getNumberOfItems
- Defined in packages/foundation/src/lib/datasources/datasource.ts:26

getObjectAtRowIndex

getObjectAtRowIndex(rowIndex: number): RowResult<T>
Returns the row object at the given index.
Parameters
- rowIndex: number
  Zero-based index of the row to retrieve.
Returns RowResult<T>
The row value, or a Promise that resolves to it.
Inherited from IDatasource.getObjectAtRowIndex
- Defined in packages/foundation/src/lib/datasources/datasource.ts:34

sortBy

sortBy(expression: SortExpression<T> | null): void
Applies the given sort expression to the datasource.

The expression is a serializable array of { columnKey, direction } objects that can safely cross network boundaries (e.g. to a REST or GraphQL backend).

Pass null to clear the current sort and restore the original order.
Parameters
- expression: SortExpression<T> | null
  One or more sort criteria in priority order, or null to clear.
Returns void
- Defined in packages/foundation/src/lib/datasources/datasource.ts:54