Namespace: fastifyHealthcheck

plugin~fastifyHealthcheck(fastifynon-null, optionsnon-null, donenon-null)

Plugin implementation.

Plugin implementation.
Parameters:
Name Type Description
fastify object Fastify instance
options object plugin configuration options
  • healthcheckUrl (string, default `/health`) for the route of the health check,
  • healthcheckUrlDisable (boolean, default false) flag to disable health check route,
  • healthcheckUrlAlwaysFail (boolean, default false) flag to always return failure from health check route (mainly for testing purposes),
  • exposeUptime (boolean, default false) flag to show even process uptime in health check results,
  • underPressureOptions (object, default empty) for options to send directly to under-pressure,
  • schemaOptions (object, default empty) for options to use for route schema,
  • configOptions (object, default empty) for options to use for route config,
done function callback, to call as last step
Source: