Berikan class @Schema() yang ditulis dengan @nestjs/mongoose milik NestJS, atau interface TypeScript biasa, dan alat ini menghasilkan contoh dokumen seperti yang akan diekspor toJSON(). _id, __v dan field timestamp ditambahkan mengikuti aturan Mongoose sendiri, meskipun class tidak mendeklarasikannya.
Gunakan untuk memastikan DTO respons di service NestJS, atau untuk menyepakati dengan tim bentuk dokumen uji di sebuah collection. Berbeda dengan halaman JS, nilai diambil dari tipe properti TypeScript, bukan dari opsi @Prop().
Mongoose (TS), termasuk class yang dipakai sebagai subdokumen agar array dan objek bersarang ikut terisi.@Schema({ timestamps: true, versionKey: false }) dan lihat createdAt serta __v diperbarui di hasil.@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 mereferensikan Attachment, jadi Message menjadi root. _id ditambahkan di depan, timestamps: true menambahkan dua field tanggal, dan versionKey: false menghapus __v. roomId, yang bertipe Types.ObjectId, menjadi string ObjectId contoh.
_id (ObjectId contoh 507f1f77bcf86cd799439011) dan, kecuali versionKey: false, __v: 0; versionKey berupa string mengganti namanya.@Schema({ timestamps: true }) menambahkan createdAt dan updatedAt sebagai string ISO.Types.ObjectId dan MongooseSchema.Types.ObjectId menjadi string ObjectId; Types.Decimal128 dan tipe numerik lainnya menjadi 0.Attachment[], menjadi array satu elemen yang diisi dari class tersebut.type UserDocument = HydratedDocument<User> diabaikan saat memilih root, jadi class schema yang sebenarnya yang menang.interface biasa tanpa @Schema juga bisa, jadi interface model seperti IUser bisa ditempel apa adanya.Ketika sebuah service langsung mengembalikan this.model.find().lean(), output ini menunjukkan key persis yang diterima client, termasuk _id dan __v yang ikut bocor ke respons.
Ubah sedikit output-nya lalu berikan ke db.messages.insertOne() untuk mengisi database lokal dengan cepat. Saat melakukannya, bungkus string ObjectId dengan ObjectId("...").
@Schema() diperlakukan sebagai subdokumen: mendapat _id sendiri (kecuali @Schema({ _id: false })) dan timestamp, tetapi tidak pernah __v. Class bersarang tanpa @Schema tetap objek biasa.@Prop({ default: ... }) berupa literal dipakai sebagai nilai contoh; opsi required dan enum tidak dibaca. Untuk kumpulan nilai yang tetap, deklarasikan literal union TypeScript dan nilai pertamanya yang dipakai.Record<string, any> yang dideklarasikan dengan @Prop({ type: Object }) muncul sebagai {"key": null}.toJSON, dan select: false tidak diterapkan._id menjadi id, tetapi output menampilkan _id.Output mengikuti toJSON() default Mongoose. Jika schema Anda menambahkan id lewat toJSON: { virtuals: true } atau transform, ganti nama key-nya di hasil.
@Prop({ type: [String] })?Nilai diambil dari tipe properti yang dideklarasikan. Dengan tags: string[] Anda mendapat [""]; tanpa tipe TypeScript sama sekali, nilainya tidak diketahui dan menjadi null.
new Schema({...}) JavaScript di sini?Gunakan halaman Mongoose (JS) ke JSON untuk objek schema JavaScript. Halaman itu membaca opsi schema seperti { type: String, enum: [...] } secara langsung.