node.js - JSdoc文件流

我创建的流为:-

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

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

最佳答案

这是一个较晚的答案，但我最近遇到了类似的问题。
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");

关于node.js - JSdoc文件流，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/47144536/