fastify-custom-healthcheck/lib/index.d.ts

Fastify plugin that allows to add custom health checks in your server

import { FastifyPluginCallback } from 'fastify';
import { addHealthCheck } from './src/customHealthCheck';

export interface CustomHealthCheckOptions {
  /** Path where health route is registered */
  path?: string;
  /** Object where you can define custom information you would like to include in healthcheck response */
  info?: Record<string, string>;
  /** Flag that enables additional information to be presented in health check object when a check fails. */
  exposeFailure?: boolean;
  /** If set to true, default schema is used for the route definition, if to false - no schema. If object is passed, it will be used as a schema. Default value is "true" */
  schema?: boolean | Record<string, any>;
}

declare module 'fastify' {
  interface FastifyInstance {
    addHealthCheck: addHealthCheck;
  }
}

declare const customHealthCheck: FastifyPluginCallback<CustomHealthCheckOptions>;
export default customHealthCheck;