From 8079f1f2d17c14a19b4c206dc2a9a4f61f53ace0 Mon Sep 17 00:00:00 2001
From: Himanshu Mishra <himanshu@orkohunter.net>
Date: Tue, 13 Jul 2021 16:13:50 +0200
Subject: [PATCH] docs: add a docstring about the default healthcheck behavior

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
---
 .../backend-common/src/service/createStatusCheckRouter.ts     | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/packages/backend-common/src/service/createStatusCheckRouter.ts b/packages/backend-common/src/service/createStatusCheckRouter.ts
index ab24a6953b..fd794cc9c4 100644
--- a/packages/backend-common/src/service/createStatusCheckRouter.ts
+++ b/packages/backend-common/src/service/createStatusCheckRouter.ts
@@ -22,6 +22,10 @@ import { errorHandler, statusCheckHandler, StatusCheck } from '../middleware';
 export interface StatusCheckRouterOptions {
   logger: Logger;
   path?: string;
+  /**
+   * If not implemented, the default express middleware always returns 200.
+   * Override this to implement your own logic for a health check.
+   */
   statusCheck?: StatusCheck;
 }