@backstage/plugin-search-common
Home > @backstage/plugin-search-common
Common functionalities for Search, to be shared between various search-enabled plugins
Interfaces
| Interface | Description |
|---|---|
| DocumentCollatorFactory | Factory class for instantiating collators. |
| DocumentDecoratorFactory | Factory class for instantiating decorators. |
| Result | |
| ResultHighlight | Metadata for result relevant document fields with matched terms highlighted via wrapping in associated pre/post tags. The UI is expected to parse these field excerpts by replacing wrapping tags with applicable UI elements for rendering. |
| ResultSet | |
| SearchDocument | Base properties that all search documents must include. |
| 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. |
| SearchQuery |
Type Aliases
| Type Alias | Description |
|---|---|
| DocumentTypeInfo | Information about a specific document type. Intended to be used in the IndexBuilder to collect information about the types stored in the index. |
| IndexableDocument | Properties related to indexing of documents. This type is only useful for backends working directly with documents being inserted or retrieved from search indexes. When dealing with documents in the frontend, use SearchDocument. |
| IndexableResult | |
| IndexableResultSet | |
| 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. |
| SearchResult | |
| SearchResultSet |