MongoDB를 위한 TypeScript GraphQL 생성기 — Numio

이럴 때 사용하세요

• 같은 엔티티의 GraphQL API 타입과 함께 MongoDB에 저장되는 문서 형태도 타입으로 관리합니다.
• 데이터 접근 코드를 작성하기 전에 @map 경로와 @link 참조가 중첩 객체와 ObjectId 배열로 어떻게 바뀌는지 확인합니다.

사용 방법

1. 타입에 @entity를, 필드에 @id, @column, @link, @embedded 또는 @map(path: ...)을 사용한 스키마를 붙여 넣습니다.
2. 출력 끝부분의 DbObject 타입을 확인합니다. GraphQL 타입 자체는 그 위에 생성됩니다.
3. 결과를 .ts 파일에 복사합니다. mongodb 패키지에서 ObjectId를 import합니다.

type User @entity {
  id: ID! @id
  email: String! @column @map(path: "login.email")
  profile: Profile! @embedded
  posts: [Post!]! @link
}

type Profile @entity(embedded: true) {
  name: String! @column
}

type Post @entity {
  id: ID! @id
  title: String! @column
}

…
export type AdditionalEntityFields = {
  path?: InputMaybe<Scalars["String"]["input"]>
  type?: InputMaybe<Scalars["String"]["input"]>
}

import { ObjectId } from "mongodb"
export type UserDbObject = {
  _id: ObjectId
  login: {
    email: string
  }
  profile: ProfileDbObject
  posts: Array<PostDbObject["_id"]>
}

export type ProfileDbObject = {
  name: string
}

export type PostDbObject = {
  _id: ObjectId
  title: string
}

세부 정보 및 제한 사항

@id는 _id: ObjectId가 되고, @link는 연결된 엔티티의 _id(리스트는 Array<PostDbObject["_id"]>)가 되며, @map(path: "login.email")은 중첩된 login 객체를 만듭니다.

디렉티브가 없는 필드(@column, @id, @link, @embedded가 없는 필드)는 DbObject 타입에 포함되지 않습니다. nullable column은 선택적 Maybe<T> 프로퍼티가 됩니다.

출력에는 표준 typescript 플러그인 타입도 포함됩니다(위 예시에서는 생략). 생성은 브라우저 Web Worker에서 실행됩니다.

FAQ

관련 도구

사양 및 참고 자료

• GraphQL Code Generator: typescript-mongodb