From 957cb4cb209e2cb3cc1e8da243628990695e234d Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Thu, 17 Feb 2022 13:55:56 +0100 Subject: [PATCH] catalog-backend: Deprecate runPeriodically function Signed-off-by: Johan Haals --- .changeset/chilled-glasses-tan.md | 5 +++++ plugins/catalog-backend/api-report.md | 2 +- plugins/catalog-backend/src/util/runPeriodically.ts | 1 + 3 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 .changeset/chilled-glasses-tan.md diff --git a/.changeset/chilled-glasses-tan.md b/.changeset/chilled-glasses-tan.md new file mode 100644 index 0000000000..e365d12ed8 --- /dev/null +++ b/.changeset/chilled-glasses-tan.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend': patch +--- + +Deprecated the `runPeriodically` function which is no longer in use. diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md index d97df9967c..09b09d07d1 100644 --- a/plugins/catalog-backend/api-report.md +++ b/plugins/catalog-backend/api-report.md @@ -1133,7 +1133,7 @@ export interface RouterOptions { // Warning: (ae-missing-release-tag) "runPeriodically" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // -// @public +// @public @deprecated export function runPeriodically(fn: () => any, delayMs: number): () => void; // Warning: (ae-missing-release-tag) "StaticLocationProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) diff --git a/plugins/catalog-backend/src/util/runPeriodically.ts b/plugins/catalog-backend/src/util/runPeriodically.ts index 2f3104e221..d3bf5d21d5 100644 --- a/plugins/catalog-backend/src/util/runPeriodically.ts +++ b/plugins/catalog-backend/src/util/runPeriodically.ts @@ -23,6 +23,7 @@ * @param delayMs - The delay between a completed function invocation and the * next. * @returns A function that, when called, stops the invocation loop. + * @deprecated use \@backstage/backend-tasks package instead. */ export function runPeriodically(fn: () => any, delayMs: number): () => void { let cancel: () => void;