paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 30 Packages Projects Releases Wiki Activity

docs: added missing param to docs

Browse Source 
Signed-off-by: Niek te Grootenhuis <niek.te.grootenhuis@alliander.com>
This commit is contained in:
Niek te Grootenhuis
2022-08-19 14:01:59 +02:00
parent 2e0689e536
commit cfddfca453
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/tech-insights-backend/src/service/fact/createFactRetriever.ts
+5 -4
View File
@@ -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