@asapjs/sequelize

@asapjs/sequelize는 ASAPJS 프레임워크의 Sequelize ORM 통합 패키지입니다. 데이터 모델링, DTO, 리포지토리 패턴, Swagger 스키마 자동 생성을 하나의 패키지에서 제공합니다.

TypeIs의 기본 타입(INT, STRING, BOOLEAN 등 16종)은 @asapjs/schema 패키지에서 정의됩니다. @asapjs/sequelize는 이 타입들을 프로퍼티 데코레이터로 래핑하여 export하며, Sequelize 전용 타입(QUERY, FOREIGNKEY, BELONGSTO)을 추가 등록합니다.

설치

npm install @asapjs/sequelize

피어 의존성:

npm install sequelize sequelize-typescript

임포트

import {
  // 데이터베이스 라이프사이클
  initSequelizeModule, getSequelize, modelsSync, healthCheck, generateDBML,
 
  // 데코레이터
  Table, Dto, TypeIs,
 
  // DTO
  ExtendableDto, PaginationQueryDto, type PaginationQueryType,
 
  // 리포지토리
  Repository,
 
  // 타입
  type DtoOrTypeIs, type TypeIsData,
 
  // 유틸리티
  getUserIdInQuery, getDBMLData, getConsoleData, setSwaggerFunctions,
} from '@asapjs/sequelize';

이 페이지에서 찾을 수 있는 것

TypeIs 빠른 참조 테이블

TypeIs 이중 사용법: 데코레이터 vs. 값

모든 TypeIs.* 함수는 두 가지 방식으로 동작합니다.

프로퍼티 데코레이터로 (엔티티 또는 DTO 클래스에서):

@TypeIs.STRING({ comment: 'Email address' })
email: string;

일반 값으로 (라우트 IOptions 또는 복합 타입의 인수로):

// 라우트 응답 옵션
response: TypeIs.BOOLEAN()
 
// 타입 조합
TypeIs.ARRAY(TypeIs.INT())
TypeIs.PAGING(UserInfoDto)

관련 항목

• 데이터베이스 라이프사이클 — 초기화, 동기화, 헬스 체크
• @Table 데코레이터 — 엔티티 정의
• TypeIs 기본 타입 — 숫자, 문자열, 불리언, 날짜
• TypeIs 특수 타입 — ENUM, JSON
• TypeIs 관계 타입 — FOREIGNKEY, BELONGSTO
• TypeIs 복합 타입 — DTO, QUERY, ARRAY
• ExtendableDto — DTO 기본 클래스
• @Dto 데코레이터 — DTO 메타데이터 및 페이지네이션
• Repository — 리포지토리 패턴
• 유틸리티 — 헬퍼 함수