Constructor.
the property to sort on
Optional
descending: booleantrue
to sort in descending order, false
for ascending
Private
Readonly
#descendingPrivate
Readonly
#keyGet the sorting direction.
true
if descending order, false
for ascending
Get the sort property name.
the sort key
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
.
Optional
index: numberan optional array property index
Optional
propertyName: stringan optional array property name, only used if index
is also provided;
defaults to sorts
the URI encoded string
Generated using TypeDoc
A description of a sort applied to a property of a collection.