push.rocks/smartstream
3
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

fix(readme): improve README: clarify entry points, add Web & Node stream examples, finalization and backpressure tips, and comprehensive API reference

Browse Source
This commit is contained in:
Jürgen Kunz
2026-03-02 07:01:47 +00:00
parent 77046acac7
commit 04d2f3223a
4 changed files with 157 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
changelog.md
+10
View File
@@ -1,5 +1,15 @@
# Changelog
## 2026-03-02 - 3.4.1 - fix(readme)
improve README: clarify entry points, add Web & Node stream examples, finalization and backpressure tips, and comprehensive API reference
- Clarified package entry points and import paths so consumers can choose Node or Web builds.
- Expanded examples: SmartDuplex finalFunction pushing multiple chunks, converting SmartDuplex to Web streams (reader/writer example), WebDuplexStream finalFunction, and a Node↔Web round-trip conversion example.
- Added guidance and examples for concurrency and backpressure (TransformStream read/write concurrency tip, reading concurrently with writes, and backpressure notes for Node↔Web converters).
- Documented StreamWrapper.streamStarted() and onCustomEvent() usage with examples showing awaiting stream startup.
- Added a new API reference section documenting SmartDuplex, WebDuplexStream, StreamWrapper, StreamIntake, nodewebhelpers, and utility functions.
- Various README wording, formatting, and example clarifications (tips, headings, and minor cosmetic fixes).
## 2026-03-02 - 3.4.0 - feat(smartduplex)
improve backpressure handling and web/node stream interoperability