BatchSearchEngineIndexer
Home > @backstage/plugin-search-backend-node > BatchSearchEngineIndexer
Base class encapsulating batch-based stream processing. Useful as a base class for search engine indexers.
Signature:
abstract class BatchSearchEngineIndexer extends Writable
Extends: Writable
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(options) | Constructs a new instance of the BatchSearchEngineIndexer class |
Methods
| Method | Modifiers | Description |
|---|---|---|
| finalize() | abstract | Any asynchronous teardown tasks can be performed here. |
| index(documents) | abstract | Receives an array of indexable documents (of size this.batchSize) which should be written to the search engine. This method won't be called again at least until it resolves. |
| initialize() | abstract | Any asynchronous setup tasks can be performed here. |