on-stream-close

Callback when a stream has closed. Alternative to stream.finished and its predecessor end-of-stream that utilize other events (like end and finish) which makes them compatible with older streams but they can't guarantee the stream has fully cleaned up its resources.

Usage

const osc = require('on-stream-close')

osc(stream, function (err) {
  // Stream has closed
})

With promises:

const osc = require('on-stream-close').promises

await osc(stream)

Compatible stream flavors

• stream: node >= 14.0.0 or >= 10.16.0 if autoDestroy is set to true by implementation
• readable-stream: >= 3.5.0 if autoDestroy is set to true by implementation
• streamx: always
• minipass: not out of the box, an implementation can choose to emit close.

Install

With npm do:

npm install on-stream-close

License

MIT © 2020-present Vincent Weevers