From 70a58c73286a6d0fb46d4af38554af0bd390e882 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Thu, 16 Sep 2021 10:29:24 +0200 Subject: [PATCH] Export RefreshService, add api-report Signed-off-by: Johan Haals --- plugins/catalog-backend/api-report.md | 21 ++++++++++++--------- plugins/catalog-backend/src/next/index.ts | 1 + 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md index 44073d19e0..76663e3c95 100644 --- a/plugins/catalog-backend/api-report.md +++ b/plugins/catalog-backend/api-report.md @@ -270,19 +270,12 @@ export type CatalogEnvironment = { // // @public (undocumented) export interface CatalogProcessingEngine { - // (undocumented) - refresh(options: CatalogProcessingEngineRefreshOptions): Promise; // (undocumented) start(): Promise; // (undocumented) stop(): Promise; } -// @public (undocumented) -export type CatalogProcessingEngineRefreshOptions = { - entityRef: string; -}; - // Warning: (ae-missing-release-tag) "CatalogProcessingOrchestrator" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -1239,7 +1232,7 @@ export interface NextRouterOptions { // (undocumented) logger: Logger_2; // (undocumented) - processingEngine?: CatalogProcessingEngine; + refreshService?: RefreshService; } // Warning: (ae-missing-release-tag) "notFoundError" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -1360,6 +1353,16 @@ export type RecursivePartial = { // @public export type RefreshIntervalFunction = () => number; +// @public +export type RefreshOptions = { + entityRef: string; +}; + +// @public +export interface RefreshService { + refresh(options: RefreshOptions): Promise; +} + // Warning: (ae-missing-release-tag) "relation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -1396,7 +1399,7 @@ export interface RouterOptions { // (undocumented) logger: Logger_2; // (undocumented) - processingEngine?: CatalogProcessingEngine; + refreshService?: RefreshService; } // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen diff --git a/plugins/catalog-backend/src/next/index.ts b/plugins/catalog-backend/src/next/index.ts index f05ba903eb..5f70dd2125 100644 --- a/plugins/catalog-backend/src/next/index.ts +++ b/plugins/catalog-backend/src/next/index.ts @@ -29,4 +29,5 @@ export type { LocationService, LocationStore, RefreshOptions, + RefreshService, } from './types';