用于文件流的 JSdoc答案

【问题标题】：JSdoc for file stream用于文件流的 JSdoc
【发布时间】：2019-06-13 15:03:59
【问题描述】：

我正在创建一个流：-

var stream = fs.createWriteStream("filepath");

现在，我将其作为参数传递给函数。在为这个方法编写 JSdoc 时，我不确定它的类型是什么。那么，谁能告诉我它在 JSdoc 中的类型是什么？

【问题讨论】：

标签： node.js jsdoc

【解决方案1】：

这是一个迟到的答案，但我最近遇到了类似的问题。

fs.createWriteStream 返回的对象属于WriteStream 类型，如API Reference of Node 所述

您可以在 jsDoc 中使用 import @type，如下所示。

const fs = require('fs');

/**
 * Some definition explaining what this constant is
 * @constant
 * @type {import('fs').WriteStream}
 */
const stream = fs.createWriteStream("filepath");

我发现了here。

就我而言，我多次重复使用WriteStream 文件，所以我使用了@typedef 和@type 的组合

/**
 * @typedef {import('fs').WriteStream} WriteStream
 */
const fs = require('fs');

/**
 * Some definition explaining what this constant is
 * @constant
 * @type WriteStream
 */
const stream = fs.createWriteStream("filepath");

【讨论】：

【解决方案2】：

我不认为 JSDocs 对此节点 api 有特定的类型。但是，您可以将类作为类型，我认为它同样有效。根据节点文档，该类是stream.Writable，因此您可以使用它。 Node Docs

【讨论】：