SortDescriptor
Premium

Updated on Nov 14, 2025

The sort descriptor used by the orderBy method.

Name Type Default Description

Name	Type	Description
compare?	`(a: any, b: any) => number`	A custom function that defines the sort order.
dir?	`"desc" \| "asc"`	The sort direction. If no direction is set, the descriptor will be skipped during processing. The available values are: `asc` `desc`
field	`string`	The field that is sorted.


(a: any, b: any) => number

A custom function that defines the sort order.


"desc" | "asc"

The sort direction. If no direction is set, the descriptor will be skipped during processing.

The available values are:


string

The field that is sorted.

SortDescriptorPremium