文件流的JSdoc

Question

我正在创建一个流:-

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

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

Answer 1

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

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

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

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");

Answer 2

我不认为JSDocs对这个node api有特定的类型。但是，您可以将类设置为type，我认为它将同样有效。根据节点文档，这个类是stream.Writable，所以你可以使用它。Node Docs