HealthIndicator
Represents an abstract health indicator with common functionalities
abstract class HealthIndicator {
protected getStatus(key: string, isHealthy: boolean, data?: { [key: string]: any; }): HealthIndicatorResult
}
Methods
Description
A custom HealthIndicator should inherit the HealthIndicator class.
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' });
}
}