From 3c84892796c7cdacc4dffc281d131055fb1e58a8 Mon Sep 17 00:00:00 2001 From: sblausten Date: Thu, 30 Jun 2022 11:07:32 +0200 Subject: [PATCH] Add documentation Signed-off-by: sblausten --- .../src/service/techInsightsContextBuilder.ts | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/plugins/tech-insights-backend/src/service/techInsightsContextBuilder.ts b/plugins/tech-insights-backend/src/service/techInsightsContextBuilder.ts index b194fb6b69..1e3eabfb8b 100644 --- a/plugins/tech-insights-backend/src/service/techInsightsContextBuilder.ts +++ b/plugins/tech-insights-backend/src/service/techInsightsContextBuilder.ts @@ -52,8 +52,10 @@ export interface TechInsightsOptions< CheckResultType extends CheckResult, > { /** - * A collection of FactRetrieverRegistrations. + * Optional collection of FactRetrieverRegistrations. * Used to register FactRetrievers and their schemas and schedule an execution loop for them. + * + * Not needed if passing in your own FactRetrieverRegistry implementation */ factRetrievers?: FactRetrieverRegistration[]; @@ -62,6 +64,11 @@ export interface TechInsightsOptions< */ factCheckerFactory?: FactCheckerFactory; + /** + * Optional FactRetrieverRegistry implementation that replaces the default one. + * + * If passing this in you don't need to pass in factRetrievers also. + */ factRetrieverRegistry?: FactRetrieverRegistry; logger: Logger;