NestJS의 @nestjs/mongoose로 작성한 @Schema() 클래스나 TypeScript 인터페이스를 넣으면, 그 도큐먼트를 toJSON()으로 내보낸 모양의 예시를 만듭니다. 클래스에 없는 _id, __v, timestamps 날짜 필드도 Mongoose가 실제로 붙이는 규칙대로 추가됩니다.
NestJS 서비스의 응답 DTO를 정리하거나, 컬렉션에 넣을 테스트 도큐먼트의 모양을 팀과 맞출 때 씁니다. JS 페이지와 달리 @Prop() 옵션이 아니라 프로퍼티의 TypeScript 타입으로 값을 정합니다.
Mongoose (TS) 칸에 스키마 클래스 파일을 붙여넣습니다. 서브도큐먼트로 쓰는 클래스도 함께 넣어야 배열·객체 안이 채워집니다.@Schema({ timestamps: true, versionKey: false })처럼 옵션을 바꾸면 결과의 createdAt·__v가 바로 달라집니다.@Schema({ _id: false })
export class Attachment {
@Prop() url: string;
@Prop() size: number;
}
@Schema({ timestamps: true, versionKey: false })
export class Message {
@Prop({ type: Types.ObjectId, ref: "Room", required: true })
roomId: Types.ObjectId;
@Prop({ required: true })
text: string;
@Prop({ type: [Attachment], default: [] })
attachments: Attachment[];
@Prop()
readAt?: Date;
}
export const MessageSchema = SchemaFactory.createForClass(Message);{
"_id": "507f1f77bcf86cd799439011",
"roomId": "507f1f77bcf86cd799439011",
"text": "",
"attachments": [
{
"url": "",
"size": 0
}
],
"readAt": "1970-01-01T00:00:00.000Z",
"createdAt": "1970-01-01T00:00:00.000Z",
"updatedAt": "1970-01-01T00:00:00.000Z"
}Message가 Attachment를 참조하므로 Message가 최상위입니다. _id가 맨 앞에 붙고 timestamps: true로 날짜 필드 두 개가 추가됐으며, versionKey: false라서 __v는 없습니다. Types.ObjectId 타입인 roomId는 예시 ObjectId 문자열이 됩니다.
_id(예시 ObjectId 507f1f77bcf86cd799439011)를 붙이고, versionKey: false가 아니면 __v: 0도 넣습니다. versionKey에 문자열을 주면 그 이름을 씁니다.@Schema({ timestamps: true })면 createdAt·updatedAt을 ISO 문자열로 추가합니다.Types.ObjectId, MongooseSchema.Types.ObjectId는 ObjectId 문자열, Types.Decimal128·Number류는 0으로 채웁니다.Attachment[]처럼 다른 클래스 배열은 그 클래스 필드로 채운 원소 하나짜리 배열이 됩니다.type UserDocument = HydratedDocument<User> 같은 타입 별칭은 최상위 판단에서 무시하고 실제 스키마 클래스를 고릅니다.@Schema가 없는 일반 interface도 읽으므로, Mongoose 모델 인터페이스(IUser)를 그대로 넣어도 됩니다.서비스가 this.model.find().lean() 결과를 그대로 반환할 때 클라이언트가 받는 키 목록을 확인하는 데 씁니다. _id와 __v가 응답에 섞여 나간다는 것도 미리 알 수 있습니다.
결과를 조금 고쳐 db.messages.insertOne()에 넣으면 로컬 개발용 데이터를 빠르게 만들 수 있습니다. 이때 ObjectId 문자열은 ObjectId("...")로 감싸 주세요.
@Schema()가 붙어 있으면 서브도큐먼트로 보고 자체 _id(@Schema({ _id: false })면 없음)와 timestamps를 붙이며, __v는 붙이지 않습니다. @Schema가 없는 중첩 클래스는 일반 객체로 둡니다.@Prop({ default: ... })가 리터럴이면 그 값을 예시 값으로 씁니다. required, enum 옵션은 읽지 않으니, 정해진 값 목록이 있다면 TypeScript 리터럴 유니온으로 선언하면 첫 값이 들어갑니다.@Prop({ type: Object })로 선언한 Record<string, any>는 {"key": null}로 보입니다.toJSON transform, select: false는 반영하지 않습니다._id를 응답에서 id로 바꿔 쓰는데 결과에는 _id로 나옵니다.이 도구는 Mongoose 기본 toJSON() 모양을 보여 줍니다. 스키마에 toJSON: { virtuals: true }나 transform으로 id를 만들었다면 결과에서 키 이름을 직접 바꿔 주세요.
@Prop({ type: [String] })처럼 옵션에만 타입이 있으면 어떻게 되나요?값은 프로퍼티 선언의 타입에서 나옵니다. tags: string[]처럼 TypeScript 타입이 적혀 있으면 [""]가 되고, 타입 없이 옵션에만 적었다면 알 수 없어 null이 됩니다.
new Schema({...})도 여기서 변환되나요?JS 스키마 객체는 Mongoose (JS) → JSON 페이지에서 변환하세요. 그쪽은 { type: String, enum: [...] } 같은 스키마 옵션을 직접 읽습니다.