简介
stream.finished 是 Node.js 中一个非常实用的模块，可以方便地监控一个可写或可读流是否已经结束，从而及时做出相应的响应。它是一个流关闭的异步事件。
在 Node.js 中，所有的流都是 EventEmitte 的实例，都提供了一些事件，比如 data、end、error 以及 close 事件。通过这些事件，我们可以及时获取到流的状态并做出相应的响应。
但是，在一些特殊情况下，流并不会自动关闭，需要我们手动来关闭。这时使用 stream.finished 便可以方便地判断流是否已经关闭，从而提高了应用程序的效率。
安装
安装 stream.finished 最简单的方法就是使用 npm，可以在控制台中执行以下命令进行安装：
npm install stream.finished --save
使用
使用 stream.finished 有两种方式：通过回调函数和通过 Promise。
回调函数
假设我们已经有了一个可写流 writable，并且需要在关闭流时做出相应的响应，可以通过以下代码实现：
-- -------------------- ---- ------- ----- ------ - ------------------ ----- -------- - --------------------------- ----- -------- - --- ----------------- ------ -------- ------- --------- ----- - ------- - --- --------------------- -- -- - --------------------- --- ------------------ ----- -- - -- ----- - --------------------- --------- - ---展开代码
上面的代码中，我们首先创建一个可写流 writable，模拟向文件中写入数据。然后在 writable 流的 finish 事件中打印流已经关闭的消息。
接下来，使用 stream.finished 模块来传入可写流和回调函数，在回调函数中判断流是否已经结束并做出相应的响应。如果出现了错误，会在控制台中打印错误信息。
Promise
如果你使用的是 Promise，可以通过以下代码实现：
-- -------------------- ---- ------- ----- ------ - ------------------ ----- - --------- - - ---------------- ----- -------- - -------------------------------------- ----- -------- - --- ----------------- ------ -------- ------- --------- ----- - ------- - --- --------------------- -- -- - --------------------- --- -------------------------- -- - -------------------- -------------- -- - --------------------- --------- ---展开代码
上面的代码中，我们首先通过 util 模块的 promisify 方法将 stream.finished 包装为 Promise 对象，方便使用。
然后我们创建一个可写流 writable，模拟向文件中写入数据。然后在 writable 流的 finish 事件中打印流已经关闭的消息。
接下来，使用 stream.finished 模块来传入可写流，并使用 Promise 来判断流是否已经结束并做出相应的响应。如果出现了错误，会在控制台中打印错误信息。
示例代码
下面是一个示例代码，展示了 stream.finished 的使用方法：
-- -------------------- ---- ------- ----- ------ - ------------------ ----- - --------- - - ---------------- ----- -------- - -------------------------------------- ----- -------- - --- ----------------- ------ -------- ------- --------- ----- - ------- - --- --------------------- -- -- - --------------------- --- -------------------------- -- - -------------------- -------------- -- - --------------------- --------- ---展开代码
总结
stream.finished 是 Node.js 中一个非常实用的模块，可以方便地监控一个可写或可读流是否已经结束，从而及时做出相应的响应。在一些特殊情况下，流并不会自动关闭，需要我们手动来关闭。这时使用 stream.finished 便可以方便地判断流是否已经关闭，从而提高了应用程序的效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f1af195403f2923b035c4c8
