klasser och gränssnitt för att skriva maskinskrivna modeller och scheman för Mongoose i Typescript med hjälp av definitivttypad

Så här gör jag:

1. Definiera TypeScript klass som kommer att definiera vår logik.
2. Definiera gränssnittet (som jag döper till Document):det är typen mongoose kommer att interagera med
3. Definiera modellen (vi kommer att kunna hitta, infoga, uppdatera...)

I koden:

import { Document, Schema, model } from 'mongoose'

// 1) CLASS
export class User {
  name: string
  mail: string

  constructor(data: {
    mail: string
    name: string
  }) {
    this.mail = data.mail
    this.name = data.name
  }
  
  /* any method would be defined here*/
  foo(): string {
     return this.name.toUpperCase() // whatever
  }
}

// no necessary to export the schema (keep it private to the module)
var schema = new Schema({
  mail: { required: true, type: String },
  name: { required: false, type: String }
})
// register each method at schema
schema.method('foo', User.prototype.foo)

// 2) Document
export interface UserDocument extends User, Document { }

// 3) MODEL
export const Users = model<UserDocument>('User', schema)

Hur skulle jag använda detta? låt oss föreställa oss att koden är lagrad i user.ts , nu skulle du kunna göra följande:

import { User, UserDocument, Users } from 'user'

let myUser = new User({ name: 'a', mail: '[email protected]' })
Users.create(myUser, (err: any, doc: UserDocument) => {
   if (err) { ... }
   console.log(doc._id) // id at DB
   console.log(doc.name) // a
   doc.foo() // works :)
})