본문으로 건너뛰기

healthCheck

데이터베이스 연결 상태를 확인합니다.

Import

import { healthCheck } from '@asapjs/sequelize';

시그니처

const healthCheck = async (): Promise<boolean>

반환값

  • Promise<boolean> — 연결 정상 시 true
  • 연결 실패 시 Error를 throw합니다.

동작

  1. Sequelize 인스턴스로 SELECT 1 쿼리 실행
  2. 1초 타임아웃 적용 (promiseTimeout)
  3. 성공 → true 반환 / 실패 → Error throw

사용 예제

import { healthCheck } from '@asapjs/sequelize';

try {
await healthCheck();
console.log('DB 연결 정상');
} catch (err) {
console.error('DB 연결 실패:', err.message);
}

RouterModule 연동

RouterModule 사용 시 /health-check 엔드포인트가 자동으로 등록되며, 이 함수를 내부적으로 호출합니다.

관련 API