如何使用打字稿为猫鼬创建自定义模式类型

Question

我正在设置一个示意图类型，以了解它如何与 typescript 和 mongoose 一起使用。该示例使用简单的正则表达式验证电子邮件，但我不知道如何注入 mongoose.d.ts 的声明

这是怎么工作的？

email.ts

import * as mongoose from 'mongoose'

function Email (path: any, options: any[]) {
  mongoose.SchemaType.call(this, path, options, 'Email')
}

Email.prototype = Object.create(mongoose.SchemaType.prototype)

Email.prototype.cast = function (email: string) {
  if (!/^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/.test(email)) {
    throw new Error('Invalid email address')
  }
  return email
}

// Typescript: Property 'Email' does not exist on type 'typeof Types'.
mongoose.Schema.Types.Email = Email

email.d.ts

declare module 'mongoose' {
  namespace Schema {
    namespace Types {
      // ???
    }
  }
}

我想在方案中得到这个结果

const schema: mongoose.Schema = new mongoose.Schema({
  email: {
    type: Email
  }
})

Answer 1

我终于做到了，我做了一个功能，但我认为我可以改进！ :)

index.d.ts

declare module 'mongoose' {
  namespace Schema {
    namespace Types {
      function Email (path: string, options: any): void
    }
  }
}

email.ts

import * as mongoose from 'mongoose'

function Email (path: string, options: any): void {
  mongoose.SchemaTypes.String.call(this, path, options)

  function isValid (val) {
    // validation logic
  }

  this.validate(isValid, options.message || 'invalid email address')
}

Object.setPrototypeOf(Email.prototype, mongoose.SchemaTypes.String.prototype)

mongoose.Types.Email = Email
mongoose.SchemaTypes.Email = Email

Answer 2

email.ts

import mongoose from 'mongoose';

export default class Email extends mongoose.SchemaType {
    cast(email: string) {
        if (!/^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/.test(email)) {
            throw new Error('Invalid email address')
        }
        return email
    }
}

mongoose.Schema.Types.Email = Email;

index.d.ts

declare module 'mongoose' {
    namespace Schema {
        namespace Types {
            class Email extends SchemaType {}
        }
    }
}