Skip to main content

Quickstart

import { getFeatureInstance, type IQHealthcheck } from '@quik/core';

const healthcheck = getFeatureInstance<IQHealthcheck>('IQHealthcheck');
healthcheck.register('database');
healthcheck.ready('database');

Notes

  • There is no top-level getHealthcheck() helper — resolve the registry through getFeatureInstance<IQHealthcheck>('IQHealthcheck'), the same feature-lookup pattern used for other core features.
  • @quik/healthcheck installs a QHealthcheck instance as the IQHealthcheck feature during setup(), replacing the framework's default no-op implementation.
  • When @quik/http is loaded, GET /health and GET /ready are registered automatically during onAfterInit — no manual route registration is needed.