A description of a sort applied to a property of a collection.

Hierarchy

  • SortDescriptor

Implements

Constructors

Properties

Accessors

Methods

Constructors

Properties

#descending: boolean
#key: string

Accessors

Methods

  • Get this object as a standard URI encoded (query parameters) string value.

    If index is provided and non-negative, then the query parameters will be encoded as an array property named propertyName. Otherwise just bare key and descending properties will be used. The descending property is only added if it is true.

    Parameters

    • Optional index: number

      an optional array property index

    • Optional propertyName: string

      an optional array property name, only used if index is also provided; defaults to sorts

    Returns string

    the URI encoded string

Generated using TypeDoc