Class RecentSearches

Hierarchy

RecentSearches

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RecentSearches(config?: RecentSearchesConfig): RecentSearches

- Defined in index.ts:41
Parameters
- Default value config: RecentSearchesConfig = {}
Returns RecentSearches

Properties

Private LIMIT

LIMIT: number

Private RANK_BY

RANK_BY: undefined | "PROXIMITY" | "TIME" | "PROXIMITY_AND_TIME"

Private RECENT_SEARCHES

RECENT_SEARCHES: Search[] = []

Private STORAGE

STORAGE: RecentSearchesStorage

Private TTL

TTL: number

Methods

Private computeMatchScore

computeMatchScore(search: Search, query: string): number

- Defined in index.ts:54
Parameters
- search: Search
- query: string
Returns number

Private filterScoredResults

filterScoredResults(search: ScoredSearch): boolean

- Defined in index.ts:69
Parameters
- search: ScoredSearch
Returns boolean

getRecentSearches

getRecentSearches(query?: undefined | string): Search[]

- Defined in index.ts:97
Retrieve recent searches for a given query. If no query is passed, returns all recent searches

Parameters
- Optional query: undefined | string
Returns Search[]

Search[]

Private initializeStorageData

initializeStorageData(): Search[]

- Defined in index.ts:78
Returns Search[]

setRecentSearch

setRecentSearch(query: string, data?: undefined | object): Search[]

- Defined in index.ts:128
Set a recent search and data related to it.

Parameters
- query: string
- Optional data: undefined | object
Returns Search[]

Search[]

Private sortScoredResults

sortScoredResults(a: ScoredSearch, b: ScoredSearch): number

- Defined in index.ts:74
Parameters
- a: ScoredSearch
- b: ScoredSearch
Returns number

Generated using TypeDoc