From 0941102161393323e4aa29b0fd05eff34ae3b503 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Mon, 29 May 2023 12:04:09 +0200
Subject: [PATCH] backend-app-api: document default lifecycle middleware
 timeout

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 .../implementations/httpRouter/createLifecycleMiddleware.ts     | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/packages/backend-app-api/src/services/implementations/httpRouter/createLifecycleMiddleware.ts b/packages/backend-app-api/src/services/implementations/httpRouter/createLifecycleMiddleware.ts
index e5e829eebe..958ae33e99 100644
--- a/packages/backend-app-api/src/services/implementations/httpRouter/createLifecycleMiddleware.ts
+++ b/packages/backend-app-api/src/services/implementations/httpRouter/createLifecycleMiddleware.ts
@@ -50,6 +50,8 @@ export interface LifecycleMiddlewareOptions {
   lifecycle: LifecycleService;
   /**
    * The maximum time that paused requests will wait for the service to start, before returning an error.
+   *
+   * Defaults to 5 seconds.
    */
   startupRequestPauseTimeout?: HumanDuration;
 }