@nestjs/terminus
Version:
Terminus integration provides readiness/liveness health checks for NestJS.
38 lines • 1.19 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.HealthIndicator = void 0;
/**
* Represents an abstract health indicator
* with common functionalities
*
* A custom HealthIndicator should inherit the `HealthIndicator` class.
*
* ```typescript
*
* class MyHealthIndicator extends HealthIndicator {
* public check(key: string) {
* // Replace with the actual check
* const isHealthy = true;
* // Returns { [key]: { status: 'up', message: 'Up and running' } }
* return super.getStatus(key, isHealthy, { message: 'Up and running' });
* }
* }
* ```
*
* @publicApi
*/
class HealthIndicator {
/**
* Generates the health indicator result object
* @param key The key which will be used as key for the result object
* @param isHealthy Whether the health indicator is healthy
* @param data Additional data which will get appended to the result object
*/
getStatus(key, isHealthy, data) {
return {
[key]: Object.assign({ status: isHealthy ? 'up' : 'down' }, data),
};
}
}
exports.HealthIndicator = HealthIndicator;
//# sourceMappingURL=health-indicator.js.map