Donnez-lui des classes @Schema() écrites avec @nestjs/mongoose de NestJS, ou de simples interfaces TypeScript, et il produit un exemple du document tel que toJSON() l'exporterait. _id, __v et les champs de timestamps sont ajoutés selon les règles de Mongoose, même quand la classe ne les déclare pas.
Utilisez-le pour fixer les DTO de réponse d'un service NestJS, ou pour vous mettre d'accord avec votre équipe sur l'allure des documents de test d'une collection. Contrairement à la page JS, les valeurs sont tirées des types de propriétés TypeScript plutôt que des options de @Prop().
Mongoose (TS), y compris les classes utilisées comme sous-documents, pour que tableaux et objets imbriqués soient remplis.@Schema({ timestamps: true, versionKey: false }) et regardez createdAt et __v se mettre à jour dans le résultat.@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 référence Attachment : Message est donc la racine. _id est placé en tête, timestamps: true ajoute deux champs de date, et versionKey: false supprime __v. roomId, typé Types.ObjectId, devient une chaîne ObjectId d'exemple.
_id (ObjectId d'exemple 507f1f77bcf86cd799439011) et, sauf versionKey: false, __v: 0 ; un versionKey chaîne le renomme.@Schema({ timestamps: true }) ajoute createdAt et updatedAt sous forme de chaînes ISO.Types.ObjectId et MongooseSchema.Types.ObjectId deviennent des chaînes ObjectId ; Types.Decimal128 et les autres types numériques deviennent 0.Attachment[], deviennent un tableau d'un élément rempli à partir de cette classe.type UserDocument = HydratedDocument<User> sont ignorés dans le choix de la racine : c'est la vraie classe de schéma qui l'emporte.interface simples sans @Schema fonctionnent aussi : une interface de modèle comme IUser peut être collée telle quelle.Quand un service renvoie directement this.model.find().lean(), cela montre les clés exactes que reçoivent les clients, y compris les _id et __v qui fuient dans la réponse.
Retouchez la sortie et passez-la à db.messages.insertOne() pour alimenter rapidement une base locale. Encapsulez alors les chaînes ObjectId dans ObjectId("...").
@Schema() sont traitées comme des sous-documents : elles reçoivent leur propre _id (sauf @Schema({ _id: false })) et leurs timestamps, mais jamais __v. Les classes imbriquées sans @Schema restent des objets simples.@Prop({ default: ... }) littéral sert de valeur d'exemple ; les options required et enum ne sont pas lues. Pour un ensemble de valeurs fixe, déclarez une union de littéraux TypeScript : sa première valeur est utilisée.Record<string, any> déclaré avec @Prop({ type: Object }) apparaît sous la forme {"key": null}.toJSON et select: false ne sont pas appliqués._id en id, mais la sortie affiche _id.La sortie suit le toJSON() par défaut de Mongoose. Si votre schéma ajoute id via toJSON: { virtuals: true } ou une transformation, renommez la clé dans le résultat.
@Prop({ type: [String] }) ?Les valeurs viennent du type déclaré de la propriété. Avec tags: string[] vous obtenez [""] ; sans aucun type TypeScript, la valeur est inconnue et devient null.
new Schema({...}) JavaScript ?Utilisez la page Mongoose (JS) vers JSON pour les objets de schéma JavaScript. Elle lit directement les options de schéma comme { type: String, enum: [...] }.