Mongoose (TS) اسکیماز کو JSON میں تبدیل کریں!

Mongoose (TS) اسکیماز درج کریں اور مثالی JSON بنائیں! Mongoose, NestJS @Prop سپورٹ۔ API دستاویزات اور ٹیسٹ request body (sample JSON) کے لیے مفید۔
Mongoose (TS)
نتیجہ
 

Mongoose (TS) اسکیماز کو JSON میں تبدیل کریں!

اسے NestJS کے @nestjs/mongoose سے لکھی گئی @Schema() کلاسز، یا سادہ TypeScript interfaces دیں، اور یہ document کی وہ مثال بناتا ہے جیسی toJSON() اسے export کرے گا۔ _id، __v اور timestamp فیلڈز Mongoose کے اپنے قواعد کے مطابق شامل کیے جاتے ہیں، چاہے کلاس انہیں ڈکلیئر نہ کرے۔

اسے NestJS سروس میں response DTOs طے کرنے کے لیے، یا اپنی ٹیم کے ساتھ یہ طے کرنے کے لیے استعمال کریں کہ کسی collection کے test documents کیسے دکھنے چاہئیں۔ JS والے صفحے کے برعکس values @Prop() options کے بجائے TypeScript property types سے لی جاتی ہیں۔

استعمال کا طریقہ

  1. schema کلاس والی فائل Mongoose (TS) باکس میں پیسٹ کریں، subdocuments کے طور پر استعمال ہونے والی کلاسز سمیت، تاکہ arrays اور nested objects بھر جائیں۔
  2. جس کلاس کا کوئی اور حوالہ نہیں دیتا وہ root بنتی ہے؛ یقینی بنائیں کہ آپ کی مرکزی document کلاس ہی آؤٹ پٹ میں ہے۔
  3. @Schema({ timestamps: true, versionKey: false }) جیسے options بدلیں اور نتیجے میں createdAt اور __v کو اپ ڈیٹ ہوتے دیکھیں۔

مثال

ان پٹ (NestJS · @nestjs/mongoose)
@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);
آؤٹ پٹ (JSON)
{
  "_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، Attachment کا حوالہ دیتا ہے، اس لیے Message root ہے۔ _id شروع میں لگایا جاتا ہے، timestamps: true دو تاریخ والے فیلڈز شامل کرتا ہے، اور versionKey: false، __v ہٹا دیتا ہے۔ Types.ObjectId type والا roomId نمونے کی ObjectId string بن جاتا ہے۔

معاون خصوصیات

  • root document کو _id (نمونہ ObjectId 507f1f77bcf86cd799439011) ملتا ہے اور، جب تک versionKey: false نہ ہو، __v: 0 بھی؛ string والا versionKey اس کا نام بدل دیتا ہے۔
  • @Schema({ timestamps: true })، createdAt اور updatedAt کو ISO strings کے طور پر آخر میں جوڑتا ہے۔
  • Types.ObjectId اور MongooseSchema.Types.ObjectId، ObjectId strings بنتے ہیں؛ Types.Decimal128 اور دوسری عددی types 0 بنتی ہیں۔
  • کسی دوسری کلاس کی arrays، جیسے Attachment[]، اسی کلاس سے بھری ایک عنصر والی array بنتی ہیں۔
  • root چنتے وقت type UserDocument = HydratedDocument<User> جیسے type aliases نظر انداز ہوتے ہیں، اس لیے اصل schema کلاس ہی منتخب ہوتی ہے۔
  • @Schema کے بغیر سادہ interface declarations بھی چلتی ہیں، اس لیے IUser جیسا model interface جوں کا توں پیسٹ کیا جا سکتا ہے۔

استعمال کے کیس

NestJS responses اور Swagger

جب کوئی سروس this.model.find().lean() سیدھا لوٹاتی ہے تو یہ بالکل وہی keys دکھاتا ہے جو clients کو ملتی ہیں، response میں رس آنے والے _id اور __v سمیت۔

mongosh کے لیے test documents

آؤٹ پٹ میں تھوڑی تبدیلی کر کے اسے db.messages.insertOne() کو دیں اور local ڈیٹا بیس جلدی بھر لیں۔ ایسا کرتے وقت ObjectId strings کو ObjectId("...") میں لپیٹیں۔

نوٹس اور حدود

  • @Schema() سے سجی nested کلاسز subdocuments سمجھی جاتی ہیں: انہیں اپنا _id (جب تک @Schema({ _id: false }) نہ ہو) اور timestamps ملتے ہیں، لیکن __v کبھی نہیں۔ @Schema کے بغیر nested کلاسز سادہ objects رہتی ہیں۔
  • literal @Prop({ default: ... }) نمونہ value کے طور پر استعمال ہوتا ہے؛ required اور enum options نہیں پڑھے جاتے۔ مقررہ values کے مجموعے کے لیے TypeScript literal union ڈکلیئر کریں تو اس کی پہلی value استعمال ہوتی ہے۔
  • @Prop({ type: Object }) سے ڈکلیئر کیا گیا Record<string, any>، {"key": null} کی صورت میں دکھائی دیتا ہے۔
  • virtuals، toJSON transforms اور select: false لاگو نہیں ہوتے۔

عام سوالات

میری API _id کا نام بدل کر id کرتی ہے، لیکن آؤٹ پٹ _id دکھاتا ہے۔

آؤٹ پٹ Mongoose کے ڈیفالٹ toJSON() کے مطابق ہے۔ اگر آپ کا schema toJSON: { virtuals: true } یا کسی transform کے ذریعے id شامل کرتا ہے تو نتیجے میں key کا نام بدل دیں۔

اگر type صرف options میں ہو، جیسے @Prop({ type: [String] })، تو کیا ہوگا؟

values property کی ڈکلیئر کی گئی type سے آتی ہیں۔ tags: string[] کے ساتھ آپ کو [""] ملتا ہے؛ اگر کوئی TypeScript type ہی نہ ہو تو value نامعلوم ہوتی ہے اور null بنتی ہے۔

کیا میں یہاں JavaScript کا new Schema({...}) تبدیل کر سکتا ہوں؟

JavaScript schema objects کے لیے Mongoose (JS) to JSON صفحہ استعمال کریں۔ وہ { type: String, enum: [...] } جیسے schema options براہ راست پڑھتا ہے۔