map.apps Bundle APIs 4.20.0
    Preparing search index...

    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
    Index

    Properties

    compare? field? reverse? valuePicker?

    Properties

    compare?: Comparator<FieldType>

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

    field?: FieldName

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

    reverse?: boolean

    To reverse the sort order (default: false).

    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