Class OfflineSearch

A OfflineSearch is an offline search module. It can be initialized at any time by passing the Mappedin object and a set of TMappedinOfflineSearchOptions options.

Hierarchy

OfflineSearch

Index

Constructors

constructor

Methods

Constructors

constructor

new OfflineSearch(mappedin: Mappedin, options?: Partial<TMappedinOfflineSearchAllOptions>): OfflineSearch

Parameters
- mappedin: Mappedin
- Optional options: Partial<TMappedinOfflineSearchAllOptions>
Returns OfflineSearch

Methods

addQuery

addQuery(params: { object: MappedinLocation | MappedinCategory | Record<string, unknown>; query: string; weight?: number }): Promise<void>

Add a custom query to the search index

Parameters
- params: { object: MappedinLocation | MappedinCategory | Record<string, unknown>; query: string; weight?: number }
  - object: MappedinLocation | MappedinCategory | Record<string, unknown>
    
    Object that is returned when query matches
  - query: string
    
    Query string to match for this object
  - Optional weight?: number
    
    Optional weight to multiply by the score
Returns Promise<void>

search

search(term: string): Promise<TMappedinOfflineSearchResult[]>

Search for a term

Parameters
- term: string
Returns Promise<TMappedinOfflineSearchResult[]>

suggest

suggest(term: string): Promise<TMappedinOfflineSearchSuggestions>

Get Suggestions for term

Parameters
- term: string
Returns Promise<TMappedinOfflineSearchSuggestions>

toJSON

toJSON(): Promise<string>

Export search index to JSON for storage/caching - this would avoid having to re-index on page reload

Returns Promise<string>