Skip to main content

Function: addHealthCheck()

addHealthCheck(__namedParameters): void

Defined in: addHealthCheck.ts:36

Adds a health check endpoint to the Koa application.

Parameters​

ParameterType
__namedParametersAddHealthCheckOptions

Returns​

void

Examples​

import { App, addHealthCheck } from '@ttoss/http-server';

const app = new App();
addHealthCheck({ app });

app.listen(3000);
// GET /health returns { status: 'ok' }
// Custom path
addHealthCheck({ app, path: '/health' });