Interface FieldSpecObject<ObjectType, FieldName, FieldType>

Specifies advanced sorting behavior for a given field.

interface FieldSpecObject<
    ObjectType,
    FieldName extends string | number | symbol,
    FieldType,
> {
    compare?: Comparator<FieldType>;
    field?: FieldName;
    reverse?: boolean;
    valuePicker?: (instance: ObjectType) => undefined | FieldType;
}

Type Parameters

  • ObjectType
  • FieldName extends string | number | symbol
  • FieldType

Properties

compare? field? reverse? valuePicker?

Properties

Optionalcompare

compare?: Comparator<FieldType>

Custom comparator function used for values of this field (optional).

Optionalfield

field?: FieldName

The field name to sort by. Numbers can be used for array indices.

Optionalreverse

reverse?: boolean

To reverse the sort order (default: false).

OptionalvaluePicker

valuePicker?: (instance: ObjectType) => undefined | FieldType

Custom value picker, used to lookup the field in the target instance. If defined, the field name can be skipped. Allows default values to be provided.

Type declaration

Settings

Member Visibility

On This Page

Properties