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

问题描述 投票:5回答:1

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

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

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

javascript node.js mongoose jsdoc
1个回答
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

希望这可以提供一些帮助,虽然它可能不完全正确。

© www.soinside.com 2019 - 2024. All rights reserved.