文件流的JSdoc

Question

我正在创建一个流，代码如下：

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

现在，我将其作为参数传递给一个函数。当为此方法编写JSdoc时，我不确定它的类型是什么。因此，有人可以告诉我在JSdoc中它的类型将是什么吗？

- Chacha

Answer 1

虽然我回答有些晚，但最近我遇到了类似的问题。

fs.createWriteStream返回的对象是WriteStream类型，如Node的API参考中所述。

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

const fs = require('fs');

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

我在这里找到相关信息。

在我的情况下，我多次重用了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");

- Aayush Sharma

Answer 2

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

- Danielo515