Question

我正在创建一个流： -

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

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

Answer 1

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

Answer 2

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

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

您可以按照以下方式在jsDoc @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");

JSdoc用于文件流

2 个答案: