Passe classes @Schema() escritas com o @nestjs/mongoose do NestJS, ou interfaces TypeScript simples, e ele gera um exemplo do documento como o toJSON() o exportaria. _id, __v e os campos de timestamp são adicionados seguindo as próprias regras do Mongoose, mesmo quando a classe não os declara.
Use para fechar os DTOs de resposta num serviço NestJS, ou para combinar com o time como devem ser os documentos de teste de uma collection. Diferente da página JS, os valores vêm dos tipos das propriedades TypeScript, e não das opções do @Prop().
Mongoose (TS), incluindo as classes usadas como subdocumentos, para que arrays e objetos aninhados sejam preenchidos.@Schema({ timestamps: true, versionKey: false }) e veja createdAt e __v se atualizarem no resultado.@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 referencia Attachment, então Message é a raiz. _id é colocado no início, timestamps: true adiciona dois campos de data e versionKey: false remove o __v. roomId, tipado como Types.ObjectId, vira uma string ObjectId de exemplo.
_id (ObjectId de exemplo 507f1f77bcf86cd799439011) e, a menos que haja versionKey: false, __v: 0; um versionKey string o renomeia.@Schema({ timestamps: true }) adiciona createdAt e updatedAt como strings ISO.Types.ObjectId e MongooseSchema.Types.ObjectId viram strings ObjectId; Types.Decimal128 e outros tipos numéricos viram 0.Attachment[], viram um array de um elemento preenchido a partir dessa classe.type UserDocument = HydratedDocument<User> são ignorados na escolha da raiz, então a classe de schema real vence.interface simples sem @Schema também funcionam, então uma interface de model como IUser pode ser colada como está.Quando um serviço retorna this.model.find().lean() direto, isto mostra exatamente as chaves que os clients recebem, incluindo o _id e o __v que vazam na resposta.
Ajuste a saída e passe para db.messages.insertOne() para popular rápido um banco local. Ao fazer isso, envolva as strings ObjectId em ObjectId("...").
@Schema() são tratadas como subdocumentos: recebem o seu próprio _id (a menos que haja @Schema({ _id: false })) e timestamps, mas nunca __v. Classes aninhadas sem @Schema continuam objetos simples.@Prop({ default: ... }) literal é usado como valor de exemplo; as opções required e enum não são lidas. Para um conjunto fixo de valores, declare uma union de literais TypeScript e o primeiro valor dela é usado.Record<string, any> declarado com @Prop({ type: Object }) aparece como {"key": null}.toJSON e select: false não são aplicados._id para id, mas a saída mostra _id.A saída segue o toJSON() padrão do Mongoose. Se o seu schema adiciona id via toJSON: { virtuals: true } ou um transform, renomeie a chave no resultado.
@Prop({ type: [String] })?Os valores vêm do tipo declarado da propriedade. Com tags: string[] você recebe [""]; sem nenhum tipo TypeScript, o valor é desconhecido e vira null.
new Schema({...}) em JavaScript?Use a página Mongoose (JS) para JSON para objetos de schema em JavaScript. Ela lê direto opções de schema como { type: String, enum: [...] }.