From b89f04d9f7247e3331e09066f318b643a160e99a Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Sun, 8 Aug 2021 18:23:18 +0200 Subject: [PATCH] config-loader,backend-common,catalog-backend: update API reports Signed-off-by: Patrik Oldsberg --- packages/backend-common/api-report.md | 14 +++++++++++++- packages/config-loader/api-report.md | 4 ++++ plugins/catalog-backend/api-report.md | 1 + 3 files changed, 18 insertions(+), 1 deletion(-) diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md index 2652dad122..a97d50c10f 100644 --- a/packages/backend-common/api-report.md +++ b/packages/backend-common/api-report.md @@ -386,13 +386,25 @@ export { isChildPath }; // Warning: (ae-missing-release-tag) "loadBackendConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public -export function loadBackendConfig(options: Options): Promise; +export function loadBackendConfig(options: Options): Promise; // Warning: (ae-missing-release-tag) "notFoundHandler" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public export function notFoundHandler(): RequestHandler; +// Warning: (ae-missing-release-tag) "ObservableConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface ObservableConfig extends Config { + // (undocumented) + subscribe( + onChange: () => void, + ): { + unsubscribe: () => void; + }; +} + // Warning: (ae-missing-release-tag) "PluginCacheManager" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public diff --git a/packages/config-loader/api-report.md b/packages/config-loader/api-report.md index 47bc22c60f..38aa0b1ebb 100644 --- a/packages/config-loader/api-report.md +++ b/packages/config-loader/api-report.md @@ -37,6 +37,10 @@ export type LoadConfigOptions = { configPaths: string[]; env?: string; experimentalEnvFunc?: EnvFunc; + watch?: { + onChange: (configs: AppConfig[]) => void; + stopSignal?: Promise; + }; }; // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md index 7286855d4e..688780039b 100644 --- a/plugins/catalog-backend/api-report.md +++ b/plugins/catalog-backend/api-report.md @@ -21,6 +21,7 @@ import { Knex } from 'knex'; import { Location as Location_2 } from '@backstage/catalog-model'; import { LocationSpec } from '@backstage/catalog-model'; import { Logger as Logger_2 } from 'winston'; +import { ObservableConfig } from '@backstage/backend-common'; import { Organizations } from 'aws-sdk'; import { PluginDatabaseManager } from '@backstage/backend-common'; import { PluginEndpointDiscovery } from '@backstage/backend-common';