From a678795d252c01b3101b1ab56bd04533081f4bf1 Mon Sep 17 00:00:00 2001 From: Andre Wanlin <67169551+awanlin@users.noreply.github.com> Date: Sat, 18 Jun 2022 12:54:28 -0500 Subject: [PATCH] Updated api-report Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com> --- .../search-backend-module-pg/api-report.md | 23 +++++++++++++------ 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/plugins/search-backend-module-pg/api-report.md b/plugins/search-backend-module-pg/api-report.md index 6a8b68a042..23e261ca4d 100644 --- a/plugins/search-backend-module-pg/api-report.md +++ b/plugins/search-backend-module-pg/api-report.md @@ -4,6 +4,7 @@ ```ts import { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node'; +import { Config } from '@backstage/config'; import { IndexableDocument } from '@backstage/plugin-search-common'; import { IndexableResultSet } from '@backstage/plugin-search-common'; import { Knex } from 'knex'; @@ -43,7 +44,7 @@ export class DatabaseDocumentStore implements DatabaseStore { // (undocumented) query( tx: Knex.Transaction, - { types, pgTerm, fields, offset, limit, preTag, postTag }: PgSearchQuery, + { types, pgTerm, fields, offset, limit, options }: PgSearchQuery, ): Promise; // (undocumented) static supported(knex: Knex): Promise; @@ -80,10 +81,15 @@ export interface DatabaseStore { // // @public (undocumented) export class PgSearchEngine implements SearchEngine { - constructor(databaseStore: DatabaseStore); + // Warning: (ae-forgotten-export) The symbol "PgSearchHighlightOptions" needs to be exported by the entry point index.d.ts + constructor( + databaseStore: DatabaseStore, + highlightOptions?: PgSearchHighlightOptions, + ); // (undocumented) static from(options: { database: PluginDatabaseManager; + config: Config; }): Promise; // (undocumented) getIndexer(type: string): Promise; @@ -95,8 +101,13 @@ export class PgSearchEngine implements SearchEngine { ): void; // (undocumented) static supported(database: PluginDatabaseManager): Promise; + // Warning: (ae-forgotten-export) The symbol "PgSearchHighlightConfig" needs to be exported by the entry point index.d.ts + // // (undocumented) - translator(query: SearchQuery): ConcretePgSearchQuery; + translator( + query: SearchQuery, + options: PgSearchHighlightConfig, + ): ConcretePgSearchQuery; } // Warning: (ae-missing-release-tag) "PgSearchEngineIndexer" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -132,12 +143,10 @@ export interface PgSearchQuery { // (undocumented) offset: number; // (undocumented) + options: PgSearchHighlightConfig; + // (undocumented) pgTerm?: string; // (undocumented) - postTag: string; - // (undocumented) - preTag: string; - // (undocumented) types?: string[]; }