plugins: generate api reports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-17 11:00:16 +02:00
parent 5429bfa69e
commit d8d7226fce
54 changed files with 5209 additions and 0 deletions
@@ -0,0 +1,68 @@
+## API Report File for "@backstage/plugin-search-backend-node"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { DocumentCollator } from '@backstage/search-common';
+import { DocumentDecorator } from '@backstage/search-common';
+import { IndexableDocument } from '@backstage/search-common';
+import { Logger } from 'winston';
+import { default as lunr_2 } from 'lunr';
+import { SearchQuery } from '@backstage/search-common';
+import { SearchResultSet } from '@backstage/search-common';
+
+// @public (undocumented)
+export class IndexBuilder {
+    constructor({ logger, searchEngine }: IndexBuilderOptions);
+    addCollator({ collator, defaultRefreshIntervalSeconds, }: RegisterCollatorParameters): void;
+    addDecorator({ decorator }: RegisterDecoratorParameters): void;
+    build(): Promise<{
+        scheduler: Scheduler;
+    }>;
+    // (undocumented)
+    getSearchEngine(): SearchEngine;
+    }
+
+// @public (undocumented)
+export class LunrSearchEngine implements SearchEngine {
+    constructor({ logger }: {
+        logger: Logger;
+    });
+    // (undocumented)
+    protected docStore: Record<string, IndexableDocument>;
+    // (undocumented)
+    index(type: string, documents: IndexableDocument[]): void;
+    // (undocumented)
+    protected logger: Logger;
+    // (undocumented)
+    protected lunrIndices: Record<string, lunr_2.Index>;
+    // (undocumented)
+    query(query: SearchQuery): Promise<SearchResultSet>;
+    // (undocumented)
+    setTranslator(translator: LunrQueryTranslator): void;
+    // (undocumented)
+    protected translator: QueryTranslator;
+}
+
+// @public
+export class Scheduler {
+    constructor({ logger }: {
+        logger: Logger;
+    });
+    addToSchedule(task: Function, interval: number): void;
+    start(): void;
+    stop(): void;
+}
+
+// @public
+export interface SearchEngine {
+    index(type: string, documents: IndexableDocument[]): void;
+    query(query: SearchQuery): Promise<SearchResultSet>;
+    setTranslator(translator: QueryTranslator): void;
+}
+
+
+// (No @packageDocumentation comment for this package)
+
+```