Backstage
    Preparing search index...

    Interface 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.

    interface SearchEngine {
        getIndexer(type: string): Promise<Writable>;
        query(
            query: SearchQuery,
            options?: QueryRequestOptions,
        ): Promise<IndexableResultSet>;
        setTranslator(translator: QueryTranslator): void;
    }

    Implemented by

    Index

    Methods

    getIndexer query setTranslator

    Methods

    • Factory method for getting a search engine indexer for a given document type.

      Parameters

      • type: string

        The type or name of the document set for which an indexer should be retrieved. This corresponds to the type property on the document collator/decorator factories and will most often be used to identify an index or group to which documents should be written.

      Returns Promise<Writable>

    Settings

    Member Visibility

    On This Page

    Methods