Class SortDescriptor

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

Implements

UriEncodable

Index

Constructors

Accessors

Methods

Constructors

constructor

new SortDescriptor(key: string, descending?: boolean): SortDescriptor
Constructor.
Parameters
- key: string
  the property to sort on
- Optionaldescending: boolean
  true to sort in descending order, false for ascending
Returns SortDescriptor
- Defined in src/main/domain/sortDescriptor.ts:16

Accessors

descending

get descending(): boolean
Get the sorting direction.

Returns boolean
true if descending order, false for ascending
- Defined in src/main/domain/sortDescriptor.ts:35

key

get key(): string
Get the sort property name.

Returns string
the sort key
- Defined in src/main/domain/sortDescriptor.ts:26

Methods

toUriEncoding

toUriEncoding(index?: number, propertyName?: string): string
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
- Optionalindex: number
  an optional array property index
- OptionalpropertyName: string
  an optional array property name, only used if index is also provided; defaults to sorts
Returns string
the URI encoded string
Implementation of UriEncodable.toUriEncoding
- Defined in src/main/domain/sortDescriptor.ts:52