Class LunrSearchEngine

Lunr specific search engine implementation.

Implements

SearchEngine

Index

Constructors

Properties

docStore highlightPostTag highlightPreTag logger lunrIndices translator

Methods

getIndexer query setTranslator

Constructors

constructor

new LunrSearchEngine(options: { logger: LoggerService }): LunrSearchEngine
Parameters
- options: { logger: LoggerService }
Returns LunrSearchEngine
- Defined in plugins/search-backend-node/src/engines/LunrSearchEngine.ts:61

Properties

`Protected`docStore

docStore: Record<string, IndexableDocument>

`Protected`highlightPostTag

highlightPostTag: string

`Protected`highlightPreTag

highlightPreTag: string

`Protected`logger

logger: LoggerService

`Protected`lunrIndices

lunrIndices: Record<string, lunr.Index> = {}

`Protected`translator

translator: QueryTranslator = ...

Methods

getIndexer

getIndexer(type: string): Promise<LunrSearchEngineIndexer>
Factory method for getting a search engine indexer for a given document type.
Parameters
- type: string
  The type or name of the document set for which an indexer should be retrieved. This corresponds to the type property on the document collator/decorator factories and will most often be used to identify an index or group to which documents should be written.
Returns Promise<LunrSearchEngineIndexer>
Implementation of SearchEngine.getIndexer
- Defined in plugins/search-backend-node/src/engines/LunrSearchEngine.ts:153

query

query(query: SearchQuery): Promise<IndexableResultSet>
Perform a search query against the SearchEngine.
Parameters
- query: SearchQuery
Returns Promise<IndexableResultSet>
Implementation of SearchEngine.query
- Defined in plugins/search-backend-node/src/engines/LunrSearchEngine.ts:191

setTranslator

setTranslator(translator: LunrQueryTranslator): void
Override the default translator provided by the SearchEngine.
Parameters
- translator: LunrQueryTranslator
Returns void
Implementation of SearchEngine.setTranslator
- Defined in plugins/search-backend-node/src/engines/LunrSearchEngine.ts:149