JsDoc:将param类型定义为来自外部模块的类型

时间:2017-06-19 06:39:23

标签: javascript node.js mongoose jsdoc

这似乎应该有一个明显的答案,但我找不到它。

var mongoose = require('mongoose')
/**
* @param {Mongoose.Model} fooModel
*/
function ExecuteAQueryUsingModel(fooModel) {

我基本上试图将参数定义为Mongoose.Model,这是一个用mongoose模型构造函数构造的变量。我不知道如何将jsdoc类型设置为外部定义的类型。

1 个答案:

答案 0 :(得分:0)

由于我只是一个业余爱好者,所以我在这里可能会遇到困难,而且我仅使用JSDoc在Visual Studio Code中获取IntelliSense。 这个JSDoc解决了我的问题:

/** @param {import("express").Response} expressResponse */
function send(expressResponse) {
    expressResponse.send('OK');
}

我无法在http://usejsdoc.org/tags-param.html中找到语法,因此这可能是特定于打字稿的。 我在这里找到了这个主意:https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html

希望这会有所帮助,尽管可能并不完全正确。

相关问题