IndexBuilder

Home > @backstage/plugin-search-backend-node > IndexBuilder

Used for adding collators, decorators and compile them into tasks which are added to a scheduler returned to the caller.

Signature:

class IndexBuilder 

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Constructs a new instance of the IndexBuilder class

Methods

Method	Modifiers	Description
addCollator(options)		Makes the index builder aware of a collator that should be executed at the given refresh interval.
addDecorator(options)		Makes the index builder aware of a decorator. If no types are provided on the decorator, it will be applied to documents from all known collators, otherwise it will only be applied to documents of the given types.
build()		Compiles collators and decorators into tasks, which are added to a scheduler returned to the caller.
getDocumentTypes()		Responsible for returning the registered document types.
getSearchEngine()		Responsible for returning the registered search engine.