From db5bf53ffe145b882b69332c0d5228d4eefd63e3 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 3 Mar 2022 10:28:42 +0100 Subject: [PATCH] chore: updating api-report with deprecations Signed-off-by: blam --- plugins/catalog-backend/api-report.md | 19 +++++++++++++++++-- .../src/service/CatalogBuilder.ts | 2 +- 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md index ee7b419a71..a0e5678e97 100644 --- a/plugins/catalog-backend/api-report.md +++ b/plugins/catalog-backend/api-report.md @@ -218,8 +218,14 @@ export class CatalogBuilder { key: string, resolver: PlaceholderResolver, ): CatalogBuilder; + setProcessingInterval( + processingInterval: ProcessingIntervalFunction, + ): CatalogBuilder; + setProcessingIntervalSeconds(seconds: number): CatalogBuilder; + // @deprecated setRefreshInterval(refreshInterval: RefreshIntervalFunction): CatalogBuilder; - setRefreshIntervalSeconds(seconds: number): CatalogBuilder; + // @deprecated + setRefreshIntervalSecon0ds(seconds: number): CatalogBuilder; } // @alpha @@ -408,6 +414,12 @@ export const createCatalogPolicyDecision: ( ) => ConditionalPolicyDecision; // @public +export function createRandomProcessingInterval(options: { + minSeconds: number; + maxSeconds: number; +}): ProcessingIntervalFunction; + +// @public @deprecated export function createRandomRefreshInterval(options: { minSeconds: number; maxSeconds: number; @@ -989,6 +1001,9 @@ export type PlaceholderResolverResolveUrl = ( base: string, ) => string; +// @public +export type ProcessingIntervalFunction = () => number; + // @public export const processingResult: Readonly<{ readonly notFoundError: ( @@ -1023,7 +1038,7 @@ export type RecursivePartial = { : T[P]; }; -// @public +// @public @deprecated export type RefreshIntervalFunction = () => number; // @public diff --git a/plugins/catalog-backend/src/service/CatalogBuilder.ts b/plugins/catalog-backend/src/service/CatalogBuilder.ts index 3d7de6ba95..179233cb28 100644 --- a/plugins/catalog-backend/src/service/CatalogBuilder.ts +++ b/plugins/catalog-backend/src/service/CatalogBuilder.ts @@ -210,7 +210,7 @@ export class CatalogBuilder { /** * Processing interval determines how often entities should be processed. * Seconds provided will be multiplied by 1.5 - * The default processing duration is 100-150 seconds. + * The default processing interval is 100-150 seconds. * setting this too low will potentially deplete request quotas to upstream services. */ setProcessingIntervalSeconds(seconds: number): CatalogBuilder {