Skip to main content

SearchEngine.getIndexer()

Home > @backstage/plugin-search-backend-node > SearchEngine > getIndexer

Factory method for getting a search engine indexer for a given document type.

Signature:

getIndexer(type: string): Promise<Writable>;

Parameters

ParameterTypeDescription
typestringThe 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<Writable>