I-convert ang JSON sa Mongoose (TypeScript) na Solusyon!

Ilagay ang JSON at i-convert ito sa Mongoose (TypeScript) na solusyon! Sinusuportahan ang NestJS @nestjs/mongoose @Schema, @Prop, SchemaFactory, MongoDB.
JSON
Resulta
 

I-convert ang JSON sa Mongoose (TypeScript) na Solusyon!

Ginagawang NestJS @nestjs/mongoose schema class ang JSON: isang @Schema() class na may @Prop() sa bawat field, ang schema na binuo gamit ang SchemaFactory.createForClass(), at isang ProductDocument type, lahat sa iisang file. May @IsNotEmpty() o @IsOptional() din ng class-validator ang bawat field.

Gamitin ito kapag kailangan ng isang NestJS module ng schema na ire-register sa MongooseModule.forFeature(), may sample ka na ng document na ise-store, at ang mano-manong pagsulat ng bawat decorator ang matagal na bahagi.

Paano gamitin

  1. I-paste sa input ang isang sample document. Kung paminsan-minsan lang lumalabas ang ilang field, i-paste ang ilang document bilang array para ma-detect ang mga optional na field.
  2. Ilagay sa Pangalan ng model ang class name (default MyModel). Kapag tinype mo ang product, lalabas ang Product, ProductDocument at ProductSchema.
  3. I-save ang resulta bilang product.schema.ts at i-register ito gamit ang MongooseModule.forFeature([{ name: Product.name, schema: ProductSchema }]).

Halimbawa

Input (JSON)
{
  "sku": "KB-87-RED",
  "title": "Mechanical keyboard",
  "price": 89.5,
  "stock": 42,
  "discontinued": false,
  "restocked_at": "2024-03-18"
}
Output (NestJS @nestjs/mongoose)
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);

Iisang document na puno ang sample, kaya nakakakuha ang bawat field ng required: true at @IsNotEmpty(). String na nasa date format ang restocked_at, kaya Date ang type nito, at napapanatili ng property ang naka-store na key name na restocked_at.

Mga sinusuportahang feature

  • Explicit ang mga Mongoose type, hal. @Prop({ type: MongooseSchema.Types.String, required: true }). Ini-import ang Schema ng Mongoose bilang MongooseSchema para hindi ito magbanggaan sa Schema decorator.
  • Mga TypeScript type: number, boolean, Date para sa mga ISO 8601 date string, string para sa lahat ng iba pa kasama ang mga string na puro digit gaya ng "0042".
  • Dine-declare ang mga nested object gamit ang MongooseSchema.Types.Mixed at may type na Record<string, unknown>; nagiging hal. [MongooseSchema.Types.String] na may string[] ang mga array ng iisang simpleng type.
  • Ang mga property name ay ang mga JSON key nang walang pagbabago, naka-quote kapag kailangan ('home-url': string), kaya tugma ang class sa mga document na nasa collection na.
  • Nakakakuha ng required: true kasama ang @IsNotEmpty() ang mga field na may hindi blangkong value sa bawat document; @IsOptional() lang ang sa iba. Nilalaktawan ang _id key sa input dahil naka-declare na ang _id: MongooseSchema.Types.ObjectId.
  • Ginagawa ang export type ProductDocument = Product & Document para sa injection gaya ng @InjectModel(Product.name) model: Model<ProductDocument>.

Mga gamit

Pagdagdag ng collection sa isang NestJS service

Ipasok ang event payload na ipinadala sa iyo ng ibang team, o ang JSON mula sa isang scraper, para makuha ang schema class, saka i-inject ito gamit ang @InjectModel at tawagin agad ang create o find.

Paglipat ng Express Mongoose model sa NestJS

Mag-export ng ilang document na na-save ng lumang new Schema({...}) na model at i-paste sila rito para isulat ulit ito bilang decorator-based na class nang walang field na nalalaglag habang mano-manong kinokopya.

Mga paalala at limitasyon

  • Nasa schema class ang @IsNotEmpty() at @IsOptional(), pero mga controller DTO ang vina-validate ng ValidationPipe. Para i-validate ang mga request, ilipat ang mga decorator na ito sa isang DTO class o gumawa ng isa.
  • Walang option ang @Schema(), kaya sinusunod ng collection name ang rule ng Mongoose na gawing lowercase at plural ang model name: products. I-set ang @Schema({ collection: 'product' }) kung kailangan mo ng partikular na pangalan.
  • Lumalabas pa ring walang ? ang mga optional na field (hal. memo: string). Kapag may strictNullChecks, mas ligtas na palitan sila ng memo?: string.
  • Naka-store bilang Mixed ang mga sub-document sa halip na typed schema. Para sa validation sa loob nila, mag-define ng hiwalay na @Schema() class at gamitin ang @Prop({ type: SubSchema }).

Mga madalas itanong

Bakit & Document sa halip na mag-extend ng Document?

Sinusunod nito ang default na pattern sa NestJS docs: nananatiling simpleng field definition ang schema class at ginagamit lang ang ProductDocument kung saan kailangan ang mga Mongoose document method gaya ng save(). Sa Mongoose 7+, direktang kapalit ang HydratedDocument<Product>.

Paano kung hindi gumagamit ng class-validator ang project ko?

Burahin ang linyang import { IsNotEmpty, IsOptional } from 'class-validator' at ang dalawang decorator sa bawat field. Ang required sa @Prop() lang ang kumokontrol sa behavior ng schema.

Kailangan ko bang i-specify ang type sa @Prop()?

Sa emitDecoratorMetadata, nai-infer ang mga simpleng type, pero pumapalya ang inference para sa mga array at union gaya ng Date | null. Tahasang isinusulat ng na-generate na code ang type para hindi magbago ang behavior kapag pinalitan mo mamaya ang TypeScript type ng isang property.