Class MatchSort<T>

A class that allows to build and run a sorting algorithm on a list of items with type T.

Type Parameters

T

Hierarchy

MatchSort
- StringMatchSort

Index

Constructors

Properties

filter matchRankFunctionList searchFunction searchListIndex

Methods

chain makeRankFunctions makeSorter onList onProperty setFilter setMatchRankFunctionList sort

Constructors

constructor

new MatchSort<T>(): MatchSort<T>
Instantiates a MatchSort object.
Type Parameters
- T
Returns MatchSort<T>
- Defined in classes/MatchSort.ts:22

Properties

`Private` filter

filter: BooleanMatchFunction<T> = ...

`Private` matchRankFunctionList

matchRankFunctionList: MatchRankFunction<T>[]

`Private` searchFunction

searchFunction: SearchFunction<T> = ...

`Private` searchListIndex

searchListIndex: SearchListIndex<T>

Methods

chain

chain(rankFunction): MatchSort<T>
Chains a new rank function to the sorting algorithm. If a chained rank function returns a rank of 0 or true, the next rank functions in the chain will be ignored. Otherwise, the resulting number will be added to the rank. If the rank function returns false, a value of 1 will be added. The final sort function will order the values by the rank, with the lowest number first.
Parameters
- rankFunction: MatchRankFunction<T>
  The rank function to chain.
Returns MatchSort<T>
- Defined in classes/MatchSort.ts:52

`Private` makeRankFunctions

makeRankFunctions(search): RankFunction<T>[]
Parameters
- search: string
Returns RankFunction<T>[]
- Defined in classes/MatchSort.ts:41

makeSorter

makeSorter(search): RankSort<T>
Instantiates a RankSort object for the given search term.
Parameters
- search: string
  The search term.
Returns RankSort<T>
The RankSort object.
- Defined in classes/MatchSort.ts:37

onList

onList(): MatchSort<T[]>
Generates a MatchSort object that applies the sorting algorithm to a two-dimensional array, where the best ranking item in each list is used in the final algorithm. This can be used to sort lists of items with multiple searchable keywords.

Returns MatchSort<T[]>
The generated MatchSort object.
- Defined in classes/MatchSort.ts:112

onProperty

onProperty<P, O>(property): MatchSort<O>
Generates a MatchSort object that applies the sorting algorithm to the given property of the values.
Type Parameters
- P extends string
- O extends {
  [key in string]: T
  }
Parameters
- property: P
  The key of the property that holds the value to sort by.
Returns MatchSort<O>
The generated MatchSort object.
- Defined in classes/MatchSort.ts:95

setFilter

setFilter(filter): MatchSort<T>
Sets the filter function.
Parameters
- filter: BooleanMatchFunction<T>
Returns MatchSort<T>
- Defined in classes/MatchSort.ts:70

setMatchRankFunctionList

setMatchRankFunctionList(matchRankFunctionList): MatchSort<T>
Allows to set all the rank functions at once. This will override any previously chained rank functions.
Parameters
- matchRankFunctionList: MatchRankFunction<T>[]
  The rank functions to set.
Returns MatchSort<T>
- Defined in classes/MatchSort.ts:62

sort

sort(search, values): T[]
Runs the sorting algorithm on the given values.
Parameters
- search: string
  The search term.
- values: T[]
  The values to sort.
Returns T[]
The sorted values.

Remarks
The result is cached, so that if the search term starts with the previous search term, the previous result is used as the input to the sort function. This applies as long as the given values array is the same object.
- Defined in classes/MatchSort.ts:86

Generated using TypeDoc