Skip to Content

유틸리티

@asapjs/sequelize가 제공하는 헬퍼 함수입니다.

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

심볼타입설명
getUserIdInQueryfunction유저 객체에서 ID 추출
getDBMLDatafunctionDBML 데이터 생성
getConsoleDatafunction콘솔 디버그 데이터 수집
setSwaggerFunctionsfunctionSwagger 함수 주입

임포트

import { getUserIdInQuery, getDBMLData, getConsoleData, setSwaggerFunctions } from '@asapjs/sequelize';

getUserIdInQuery()

function getUserIdInQuery(user?: any): string | number | undefined

user 객체에서 사용자 ID를 추출합니다. TypeIs.QUERYquery 함수 내부에서 사용자 스코프 SQL을 생성할 때 사용합니다.

@TypeIs.QUERY({ query: ({ user }) => { const userId = getUserIdInQuery(user); return `(SELECT COUNT(*) FROM likes WHERE likes.user_id = ${userId})`; }, type: () => TypeIs.INT(), }) like_count: number;

getDBMLData()

function getDBMLData(): string

@Table 데코레이터로 등록된 모든 테이블의 DBML(Database Markup Language) 표현을 생성하여 반환합니다. 데이터베이스 스키마 시각화 도구와 함께 사용할 수 있습니다.


getConsoleData()

function getConsoleData(): object

등록된 모든 테이블과 DTO의 디버그 정보를 수집하여 반환합니다. 관리자 콘솔이나 개발 도구에서 현재 데이터 모델의 상태를 확인할 때 사용합니다.


setSwaggerFunctions()

function setSwaggerFunctions(functions: { addScheme: (data: { name: string; data: object }) => void; generateSchemeRefWithName: (name: string) => string; }): void

Swagger 스키마 등록 및 $ref 생성 함수를 주입합니다. @asapjs/sequelize 패키지가 Swagger 통합 시 내부적으로 사용하는 함수를 설정합니다. 일반적으로 프레임워크 초기화 과정에서 자동으로 호출되므로 직접 사용할 필요가 없습니다.


관련 항목

Last updated on