Menukar JSON kepada kelas skema @nestjs/mongoose NestJS: kelas @Schema() dengan @Prop() pada setiap field, skema yang dibina dengan SchemaFactory.createForClass(), dan jenis ProductDocument, semuanya dalam satu fail. Setiap field juga membawa @IsNotEmpty() atau @IsOptional() daripada class-validator.
Gunakannya apabila modul NestJS memerlukan skema untuk didaftarkan dengan MongooseModule.forFeature(), anda sudah mempunyai sampel dokumen yang hendak disimpan, dan menulis setiap decorator secara manual ialah bahagian yang memakan masa.
Nama model (lalai MyModel). Menaip product menghasilkan Product, ProductDocument dan ProductSchema.product.schema.ts dan daftarkannya dengan MongooseModule.forFeature([{ name: Product.name, schema: ProductSchema }]).{
"sku": "KB-87-RED",
"title": "Mechanical keyboard",
"price": 89.5,
"stock": 42,
"discontinued": false,
"restocked_at": "2024-03-18"
}import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
import { Document, Schema as MongooseSchema } from 'mongoose';
import { IsNotEmpty, IsOptional } from 'class-validator';
export type ProductDocument = Product & Document;
@Schema()
export class Product {
_id: MongooseSchema.Types.ObjectId;
@Prop({ type: MongooseSchema.Types.String, required: true })
@IsNotEmpty()
sku: string;
@Prop({ type: MongooseSchema.Types.String, required: true })
@IsNotEmpty()
title: string;
@Prop({ type: MongooseSchema.Types.Number, required: true })
@IsNotEmpty()
price: number;
@Prop({ type: MongooseSchema.Types.Number, required: true })
@IsNotEmpty()
stock: number;
@Prop({ type: MongooseSchema.Types.Boolean, required: true })
@IsNotEmpty()
discontinued: boolean;
@Prop({ type: MongooseSchema.Types.Date, required: true })
@IsNotEmpty()
restocked_at: Date;
}
export const ProductSchema = SchemaFactory.createForClass(Product);Sampel ialah satu dokumen yang diisi sepenuhnya, jadi setiap field mendapat required: true dan @IsNotEmpty(). restocked_at ialah string berformat tarikh, jadi jenisnya Date, dan property mengekalkan nama kunci tersimpan restocked_at.
@Prop({ type: MongooseSchema.Types.String, required: true }). Schema Mongoose diimport sebagai MongooseSchema supaya tidak bertembung dengan decorator Schema.number, boolean, Date untuk string tarikh ISO 8601, string untuk yang lain termasuk string yang terdiri daripada digit sahaja seperti "0042".MongooseSchema.Types.Mixed dan berjenis Record<string, unknown>; array satu jenis nilai biasa menjadi, contohnya, [MongooseSchema.Types.String] dengan string[].'home-url': string), jadi kelas itu sepadan dengan dokumen yang sudah ada dalam collection.required: true serta @IsNotEmpty(); selebihnya hanya mendapat @IsOptional(). Kunci _id dalam input dilangkau kerana _id: MongooseSchema.Types.ObjectId sudah diisytiharkan.export type ProductDocument = Product & Document dijana untuk injection seperti @InjectModel(Product.name) model: Model<ProductDocument>.Masukkan payload event yang dihantar oleh pasukan lain, atau JSON daripada scraper, untuk mendapatkan kelas skema, kemudian inject dengan @InjectModel dan terus panggil create atau find.
Eksport beberapa dokumen yang disimpan oleh model lama new Schema({...}) dan tampalkannya di sini untuk menulis semula sebagai kelas berasaskan decorator tanpa field tercicir semasa menyalinnya secara manual.
@IsNotEmpty() dan @IsOptional() terletak pada kelas skema, tetapi ValidationPipe mengesahkan DTO controller. Untuk mengesahkan request, pindahkan decorator ini ke kelas DTO atau cipta satu.@Schema() tiada opsyen, jadi nama collection mengikut peraturan Mongoose yang menukar nama model kepada huruf kecil dan bentuk jamak: products. Tetapkan @Schema({ collection: 'product' }) jika anda memerlukan nama tertentu.? (cth. memo: string). Dengan strictNullChecks, menukarnya kepada memo?: string adalah lebih selamat.Mixed, bukan skema berjenis. Untuk validasi di dalamnya, takrifkan kelas @Schema() yang berasingan dan gunakan @Prop({ type: SubSchema }).& Document dan bukan extend Document?Ia mengikut corak lalai dalam dokumentasi NestJS: kelas skema kekal sebagai definisi field biasa dan ProductDocument hanya digunakan di tempat yang memerlukan method dokumen Mongoose seperti save(). Pada Mongoose 7+, HydratedDocument<Product> ialah alternatif yang boleh terus digunakan.
Padam baris import { IsNotEmpty, IsOptional } from 'class-validator' dan dua decorator pada setiap field. Tingkah laku skema dikawal oleh required dalam @Prop() sahaja.
type dalam @Prop()?Dengan emitDecoratorMetadata, jenis mudah boleh disimpulkan, tetapi inferens gagal untuk array dan union seperti Date | null. Kod yang dijana menyatakan type sejak awal supaya tingkah laku kekal sama apabila anda kemudiannya menukar jenis TypeScript sesuatu property.