docs: add a docstring about the default healthcheck behavior

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
This commit is contained in:
Himanshu Mishra
2021-07-13 16:13:50 +02:00
parent 7a6a3586ac
commit 8079f1f2d1
@@ -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;
}