From cfddfca453611eac16ec26fb07afee57f9ca95da Mon Sep 17 00:00:00 2001 From: Niek te Grootenhuis Date: Fri, 19 Aug 2022 14:01:59 +0200 Subject: [PATCH] docs: added missing param to docs Signed-off-by: Niek te Grootenhuis --- .../src/service/fact/createFactRetriever.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/plugins/tech-insights-backend/src/service/fact/createFactRetriever.ts b/plugins/tech-insights-backend/src/service/fact/createFactRetriever.ts index c14cc260f9..6f1cc25d48 100644 --- a/plugins/tech-insights-backend/src/service/fact/createFactRetriever.ts +++ b/plugins/tech-insights-backend/src/service/fact/createFactRetriever.ts @@ -27,6 +27,7 @@ import { Duration } from 'luxon'; * @param cadence - cron expression to indicate when the fact retriever should be triggered * @param factRetriever - Implementation of fact retriever consisting of at least id, version, schema and handler * @param lifecycle - Optional lifecycle definition indicating the cleanup logic of facts when this retriever is run + * @param timeout - Optional duration to determine how long the fact retriever should be allowed to run, defaults to 5 minutes * */ export type FactRetrieverRegistrationOptions = { @@ -40,10 +41,10 @@ export type FactRetrieverRegistrationOptions = { * @public * * A helper function to construct fact retriever registrations. - * - * @param cadence - cron expression to indicate when the fact retriever should be triggered - * @param factRetriever - Implementation of fact retriever consisting of at least id, version, schema and handler - * @param lifecycle - Optional lifecycle definition indicating the cleanup logic of facts when this retriever is run + * @param options.cadence - Cron expression to indicate when the fact retriever should be triggered + * @param options.factRetriever - Implementation of fact retriever consisting of at least id, version, schema and handler + * @param options.lifecycle - Optional lifecycle definition indicating the cleanup logic of facts when this retriever is run + * @param options.timeout - Optional duration to determine how long the fact retriever should be allowed to run, defaults to 5 minutes * * * @remarks