TypeScript:类型的参数不可分配

时间:2017-03-12 20:25:52

标签: javascript typescript mongoose

TypeScript newbie here迁移现有项目。我们有Mongoose模型,它们看起来类似于以下代码段并使用discriminatorKey属性:

const task = new mongoose.Schema({
  name: {
    type: String
  },
  notes: {
    type: String
  }
}, {
  discriminatorKey: 'type',
  toObject: {
    virtuals: true
  },
  toJSON: {
    virtuals: true
  }
});

这在编译期间给出了以下错误:

src/models/task.ts(12,3): error TS2345: Argument of type '{ discriminatorKey: string; }' is not assignable to parameter of type 'SchemaOptions'.
  Object literal may only specify known properties, and 'discriminatorKey' does not exist in type 'SchemaOptions'.

我正在使用这些@types定义,这似乎是最新的定义:

"@types/mongoose": "^4.7.8"

我理解,类型定义没有指定discriminatorKey(这在查看node_modules/@types/mongoose/index.d.ts时显然是可见的),但我不明白(a)为什么(疏忽?不同的版本?其他原因?),(b)我该如何规避这个错误?

(c)奖金问题:@types定义的版本控制策略对我来说仍然不清楚。我认为,类型定义应该与实际库的版本匹配,但是,通常似乎没有匹配的版本 - 例如我们正在使用express版本。 4.13.4,但没有匹配的@types/express版本。在这种情况下,最好的做法是什么?

1 个答案:

答案 0 :(得分:1)

我有点晚了,但我刚遇到同样的问题。我使用的是@types/mongoose 4.7.12,但尚未更新。

作为一种时间解决方案,当您遇到此类问题时,您有两种选择:

将整个有问题的对象投射到any

在定义内联选项时,您可以将它们转换为any

const task: mongoose.Schema = new mongoose.Schema({ ... }, {
    discriminatorKey: 'type',

    ...
} as any);

const task: mongoose.Schema = new mongoose.Schema({ ... }, <any> {
    discriminatorKey: 'type',

    ...
});

这种方法的缺点是现在对所有属性都禁用了SchemaOptions对象的类型检查,所以如果输入错误,请说toJSON,并输入toJSNO代替,TypeScript不会警告您。

仅在使用未知属性的语句中将有问题的对象投射到any

保持类型检查适用于已知属性但为尚未未知属性禁用它的另一种方法是使用已知属性定义该选项对象,并在稍后将其转换为未知属性any

const options: mongoose.SchemaOptions = {
    toObject: { virtuals: true },
    toJSON: { virtuals: true },
};

(options as any).discriminatorKey = 'type';

// or (<any> options).discriminatorKey = 'type';

const task = new mongoose.Schema({ ... }, options);

旁注:请捐款!

如果您在此软件包或将来的任何其他问题中发现任何类似问题,这是一个非常简单且最小的更改,您可以修复并将PR更改为DefinitelyTyped。实际上,对于像这样的东西,你甚至不需要克隆回购,我只能通过使用GitHub中的编辑按钮来实现。

这是PR:https://github.com/DefinitelyTyped/DefinitelyTyped/pull/16598,一旦合并,只需更新到最新版本。