v8 release notes

[ehmicky]

I think we are ready to release v8.0.0, what do you think?
Here are some potential release notes that you can feel free to pick/tweak.
Note: the links to issues/PRs do not show their titles in GitHub releases, so it looks less verbose.

---

Breaking

• Remove the encoding option. (Remove encoding option #69, Issues with the encoding option #67)
  • This package handles binary, UTF-8 and object streams.
  • For other encodings like UTF-16, hexacimal and base64, please see the following tip. (Document using TextDecoderStream #84)
  • Methods like buffer.toString('hex') or buffer.toString('base64') can also be used.

Features

• Support any JavaScript environment, including browsers. (Support any JavaScript environment #85)
• Support web streams (ReadableStream). (Add support for ReadableStream #82, Add support for TypedArray stream chunks #78, Add support for DataView stream chunks #79, Add support for ArrayBuffer stream chunks #80)
• Support async iterables. (Remove encoding option #69, Document support for async iterables #93)
• Add getStreamAsArray() method to pass streams in object mode. (Add support for streams in object mode #86)
• Add getStreamAsArrayBuffer() method to return the stream as an ArrayBuffer. (Add getStreamAsArrayBuffer() method #81)
• When the stream is larger than the maximum size for a string, buffer or ArrayBuffer, set error.bufferedData with the partially read data instead of leaving it empty. (Truncate error.bufferedData if too large #68, range error thrown when using createWriteStream() #48)

Bug fixes

• Do not crash on big streams (with one/many GBs). (Do not crash on big streams #66)
• Ensure maxBuffer stops infinite streams. (Handle infinite streams #62)
• Stop consuming the streaming when hitting maxBuffer. (maxBuffer doesn't stop buffering data when reached #42, Remove encoding option #69).
• Set error.bufferedData when the stream errors for other reasons than maxBuffer. (error.bufferedData is missing in 7.0.0 (except on maxBuffer error) #56, Set error.bufferedData when stream errors #63)
• Ensure error.bufferedData is smaller than maxBuffer. (Fix bufferedData being larger than maxBuffer #89)

TypeScript Types

• The stream argument must be a Readable, ReadableStream or AsyncIterable. (Improve TypeScript types #71)

Documentation

• Add tips on alternatives, Blob and JSON streaming. (Document node:stream/consumers #58, Document how to create Blobs #95, Document how to stream JSON arrays #96, Improve Alternatives documentation #97)

Performance

• Do not block the event loop when the stream ends. (Remove end-of-stream blocking #92)
• Add benchmarks. (Add benchmarks #94)

[sindresorhus]

Done: https://github.com/sindresorhus/get-stream/releases/tag/v8.0.0

Thank you so much for your great work with this release. This package is just so much better now in every way. 🎉

Are you interested in being added as a maintainer? No worries if not.

[ehmicky]

Thanks for the kind words @sindresorhus!
Those PRs were lots of fun.
Yes, absolutely, I would be interested, I had already starting watching the repository for new issues posting :)

[sindresorhus]

Awesome 👍

[ehmicky]

👏