@journeyapps/reactor-lib-search

Classes

Class	Description
SearchResult	-

Interfaces

SearchEngineInterface

Type Parameters

Type Parameter	Default type
T extends SearchResultEntry	-
S extends SearchEvent	SearchEvent

Methods

doSearch()

doSearch(event): SearchResult<T>;

Parameters

Parameter	Type
event	SearchEvent

Returns

SearchResult<T>

---

SearchEvent

Properties

Property	Type
matches	(input, options?) => SearchEventMatch
search	string

---

SearchResultEntry

Properties

Property	Type
key	string

---

SearchResultListener

Properties

Property	Type	Description
dispose	() => any	Called when the search results are disposed of
loadMore	() => any	-

Type Aliases

SearchEventLocators

type SearchEventLocators = {
  locatorEnd: number;
  locatorStart: number;
}[];

Type Declaration

Name	Type
locatorEnd	number
locatorStart	number

---

SearchEventMatch

type SearchEventMatch = 
  | {
  locators: SearchEventLocators;
}
  | false;

---

SearchEventMatcher

type SearchEventMatcher = (a) => SearchEventMatch;

Parameters

Parameter	Type
a	string

Returns

SearchEventMatch

Variables

trimSearch

const trimSearch: (a) => string & MemoizedFunction;

Fast search term generator that trims and null checks

Functions

Function	Description
createSearchEventMatcher	-
createSearchEventMatcherBool	-