TanStack

CreatedSortFn

Interface: CreatedSortFn()<TFeatures, TData>

Defined in: features/row-sorting/rowSortingFeature.types.ts:81

The shape returned by constructSortFn: a SortFn with its definition attached, so variants can be built by spreading it into another constructSortFn call.

The call signature is generic so a created sorting function can be used with any table's rows, regardless of the feature set it was defined against.

Extends

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

ts
CreatedSortFn<TRowFeatures, TRowData>(
   rowA,
   rowB,
   columnId): number;

Defined in: features/row-sorting/rowSortingFeature.types.ts:85

The shape returned by constructSortFn: a SortFn with its definition attached, so variants can be built by spreading it into another constructSortFn call.

The call signature is generic so a created sorting function can be used with any table's rows, regardless of the feature set it was defined against.

Type Parameters

TRowFeatures

TRowFeatures extends TableFeatures

TRowData

TRowData extends RowData

Parameters

rowA

Row<TRowFeatures, TRowData>

rowB

Row<TRowFeatures, TRowData>

columnId

string

Returns

number

Properties

resolveDataValue?

ts
optional resolveDataValue: TransformDataValueFn;

Defined in: features/row-sorting/rowSortingFeature.types.ts:69

Inherited from

SortFnDef.resolveDataValue


sort()

ts
sort: (dataValueA, dataValueB, rowA, rowB, columnId) => number;

Defined in: features/row-sorting/rowSortingFeature.types.ts:62

Parameters

dataValueA

any

dataValueB

any

rowA

Row<TFeatures, TData>

rowB

Row<TFeatures, TData>

columnId

string

Returns

number

Inherited from

SortFnDef.sort