Skip to main content
Version: Next

@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

IndexBuilder

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

LunrSearchEngine

Lunr specific search engine implementation.

LunrSearchEngineIndexer

Lunr specific search engine indexer

MissingIndexError

Failed to query documents for index that does not exist.

NewlineDelimitedJsonCollatorFactory

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

Scheduler responsible for all search tasks.

TestPipeline

Test utility for Backstage Search collators, decorators, and indexers.

Abstract Classes

Abstract Class

Description

BatchSearchEngineIndexer

Base class encapsulating batch-based stream processing. Useful as a base class for search engine indexers.

DecoratorBase

Base class encapsulating simple async transformations. Useful as a base class for Backstage search decorators.

Interfaces

Interface

Description

RegisterCollatorParameters

Parameters required to register a collator.

RegisterDecoratorParameters

Parameters required to register a decorator

SearchEngine

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

BatchSearchEngineOptions

Options for BatchSearchEngineIndexer

ConcreteLunrQuery

Type of translated query for the Lunr Search Engine.

IndexBuilderOptions

Options required to instantiate the index builder.

LunrQueryTranslator

Translator responsible for translating search term and filters to a query that the Lunr Search Engine understands.

NewlineDelimitedJsonCollatorFactoryOptions

Options for instantiate NewlineDelimitedJsonCollatorFactory

QueryRequestOptions

Options when querying a search engine.

QueryTranslator

A type of function responsible for translating an abstract search query into a concrete query relevant to a particular search engine.

ScheduleTaskParameters

ScheduleTaskParameters

TestPipelineResult

Object resolved after a test pipeline is executed.