Class Sorter<Entity>

Entity Array Sorter

Sorting functions sort the array in place and also return the sorted array.

Type Parameters

Entity extends Object

Hierarchy

Sorter

Index

Constructors

Properties

array collator comparator sortParent sortProperty

Methods

_arraySortProperty hsort psort sort

Constructors

constructor

new Sorter<Entity>(array): Sorter<Entity>
Type Parameters
- Entity extends Object
Parameters
- array: Entity[]
Returns Sorter<Entity>
- Defined in Sorter.ts:24

Properties

array

array: (Entity & {
[k: string]: any;
})[]

`Private` collator

collator: Collator = ...

`Private` comparator

comparator: undefined | ((a, b) => number) = undefined

Type declaration

- (a, b): number
- Parameters
  - a: any
  - b: any
  Returns number

`Private` sortParent

sortParent: null | string = null

`Private` sortProperty

sortProperty: null | string = null

Methods

`Private` _arraySortProperty

_arraySortProperty(a, b): number
Parameters
- a: Entity & {
  [k: string]: any;
  }
- b: Entity & {
  [k: string]: any;
  }
Returns number
- Defined in Sorter.ts:28

hsort

hsort(property, parentProperty, sortOptions?): Entity[]
Sort an array of entities hierarchically by a specified property's value.

Entities will be placed immediately after their parents. The parentProperty property, if present, should hold either null, undefined, or the entity's parent.
Parameters
- property: string
  
  The name of the property to sort entities by.
- parentProperty: string
  
  The name of the property which holds the parent of the entity.
- Optional sortOptions: SortOptions
Returns Entity[]
- Defined in Sorter.ts:92

psort

psort(property, parentProperty, __namedParameters?): Entity[]
Sort an array of entities by parent and a specified property's value.

Entities' will be sorted by their parents' properties, then the entities' properties.
Parameters
- property: string
  
  The name of the property to sort entities by.
- parentProperty: string
  
  The name of the property which holds the parent of the entity.
- __namedParameters: SortOptions = {}
Returns Entity[]
- Defined in Sorter.ts:184

sort

sort(property, __namedParameters?): Entity[]
Sort an array of entities by a specified property's value.
Parameters
- property: string
  
  The name of the property to sort entities by.
- __namedParameters: SortOptions = {}
Returns Entity[]
- Defined in Sorter.ts:217

Generated using TypeDoc