@backstage/plugin-search-backend-node
Home > @backstage/plugin-search-backend-node
A library for Backstage backend plugins that want to interact with the search backend plugin
Classes
Class |
Description |
---|---|
Used for adding collators, decorators and compile them into tasks which are added to a scheduler returned to the caller. | |
Lunr specific search engine implementation. | |
Lunr specific search engine indexer | |
Failed to query documents for index that does not exist. | |
Factory class producing a collator that can be used to index documents sourced from the latest newline delimited JSON file matching a given search pattern. "Latest" is determined by the name of the file (last alphabetically is considered latest). | |
Scheduler responsible for all search tasks. | |
Test utility for Backstage Search collators, decorators, and indexers. |
Abstract Classes
Abstract Class |
Description |
---|---|
Base class encapsulating batch-based stream processing. Useful as a base class for search engine indexers. | |
Base class encapsulating simple async transformations. Useful as a base class for Backstage search decorators. |
Interfaces
Interface |
Description |
---|---|
Parameters required to register a collator. | |
Parameters required to register a decorator | |
Interface that must be implemented by specific search engines, responsible for performing indexing and querying and translating abstract queries into concrete, search engine-specific queries. |
Type Aliases
Type Alias |
Description |
---|---|
Options for BatchSearchEngineIndexer | |
Type of translated query for the Lunr Search Engine. | |
Options required to instantiate the index builder. | |
Translator responsible for translating search term and filters to a query that the Lunr Search Engine understands. | |
Options for instantiate NewlineDelimitedJsonCollatorFactory | |
Options when querying a search engine. | |
A type of function responsible for translating an abstract search query into a concrete query relevant to a particular search engine. | |
ScheduleTaskParameters | |
Object resolved after a test pipeline is executed. |