From 05644d862e0ff3be0c2a1db225f66288f69acc32 Mon Sep 17 00:00:00 2001
From: Hao Luo <howlowck@gmail.com>
Date: Mon, 17 Oct 2022 17:10:16 -0500
Subject: [PATCH] added TSDocs for the option

Signed-off-by: Hao Luo <howlowck@gmail.com>
---
 .../src/scaffolder/tasks/TaskWorker.ts             | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.ts
index 1dc8d01aad..9af818c421 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.ts
@@ -51,6 +51,18 @@ export type CreateWorkerOptions = {
   workingDirectory: string;
   logger: Logger;
   additionalTemplateFilters?: Record<string, TemplateFilter>;
+  /**
+   * The number of tasks that can be executed at the same time by the worker
+   * @defaultValue 10
+   * @example
+   * ```
+   * {
+   *   concurrentTasksLimit: 1,
+   *   // OR
+   *   concurrentTasksLimit: Infinity
+   * }
+   * ```
+   */
   concurrentTasksLimit?: number;
   additionalTemplateGlobals?: Record<string, TemplateGlobal>;
 };
@@ -75,7 +87,7 @@ export class TaskWorker {
       integrations,
       workingDirectory,
       additionalTemplateFilters,
-      concurrentTasksLimit = 2, // Or Infinity
+      concurrentTasksLimit = 10, // from 1 to Infinity
       additionalTemplateGlobals,
     } = options;