Interface ISorter<T, R>

Type Parameters

T
R

Hierarchy

ISorter

ISorter(a: T, b: T): number
Parameters
- a: T
- b: T
Returns number
- Defined in src/game/utilities/collection/sort/Sorter.ts:16

Index

Methods

addFallback setMapper setReverse setSorter

Methods

addFallback

addFallback<A>(fallback?: SortFallback<T, R, A>, ...args: A): ISorter<T, R>
Sets a fallback sorter for when two items are in the same position
Type Parameters
- A extends any[]
Parameters
- Optional fallback: SortFallback<T, R, A>
- Rest ...args: A
Returns ISorter<T, R>
- Defined in src/game/utilities/collection/sort/Sorter.ts:28

setMapper

setMapper<A>(mapper: EntryMapper<T, R, A>, ...args: A): ISorter<T, R>
Sets a custom entry mapper, which takes an item to sort and returns a string or number representing its "sort value", which is what is actually compared.

These values are cached by the sorter
Type Parameters
- A extends any[]
Parameters
- mapper: EntryMapper<T, R, A>
- Rest ...args: A
Returns ISorter<T, R>
- Defined in src/game/utilities/collection/sort/Sorter.ts:41

setReverse

setReverse(): ISorter<T, R>
Sets this sort to be reversed

Returns ISorter<T, R>
- Defined in src/game/utilities/collection/sort/Sorter.ts:20
setReverse(reverse: boolean): ISorter<T, R>
Sets whether this sort should be reversed
Parameters
- reverse: boolean
Returns ISorter<T, R>
- Defined in src/game/utilities/collection/sort/Sorter.ts:24

setSorter

setSorter<A>(sorter?: SortFallback<T, R, A>, ...args: A): ISorter<T, R>
Sets a custom sorter to override the default sort functionality

Note: When a custom sorter is used, fallbacks registered in setFallback will not be.
Type Parameters
- A extends any[]
Parameters
- Optional sorter: SortFallback<T, R, A>
- Rest ...args: A
Returns ISorter<T, R>
- Defined in src/game/utilities/collection/sort/Sorter.ts:34

Generated using TypeDoc