jmap-kit
    Preparing search index...

    Type Alias Comparator<TObj>

    An object used to specify the sorting order for /query and /queryChanges calls.

    The interface of the object whose properties are being compared for sorting

    type Comparator<TObj extends BaseObject> = {
        collation?: string;
        isAscending?: boolean;
        property: keyof TObj;
    }

    Type Parameters

    Index

    Properties

    collation? isAscending? property

    Properties

    collation?: string

    (default is server dependent) The identifier, as registered in the collation registry defined in RFC 4790, for the algorithm to use when comparing the order of strings. The algorithms the server supports are advertised in the capabilities object returned with the Session object.

    isAscending?: boolean

    (default: true) If true, sort in ascending order. If false, reverse the comparator’s results to sort in descending order.

    property: keyof TObj

    The name of the property on the Foo objects to compare.

    Settings

    Member Visibility

    On This Page

    Properties