diff --git a/.github/workflows/pull-request-docs.yml b/.github/workflows/pull-request-docs.yml new file mode 100644 index 000000000..2fc4ce65d --- /dev/null +++ b/.github/workflows/pull-request-docs.yml @@ -0,0 +1,27 @@ +name: Pull Request + +on: + pull_request: + paths: + - docs + - packages/*/src/**/*.ts + types: [opened, synchronize] + +concurrency: + cancel-in-progress: true + group: pr-docs-${{ github.head_ref }} + +jobs: + test: + name: Docs Artifact + runs-on: ubuntu-latest + if: github.actor != 'renovate[bot]' || github.actor != 'dependabot[bot]' + steps: + - name: Build Docs + run: yarn build:docs + + - name: Upload Docs + uses: actions/upload-artifact@v3 + with: + name: docs + path: docs diff --git a/docs/extensions/sinks.md b/docs/extensions/sinks.md index b1eeba525..4003f1ef6 100644 --- a/docs/extensions/sinks.md +++ b/docs/extensions/sinks.md @@ -25,6 +25,6 @@ You can combine a number of sink implmentations by using the [SinkComposite](/st ```typescript new WritableStream( - new SinkComposite([new ForkableRecallSink(), write(console.info)]) + new SinkComposite([new ForkableRecallSink(), write(console.info)]), ) ``` diff --git a/docs/extensions/sources.md b/docs/extensions/sources.md index 439fe1179..dd023fc81 100644 --- a/docs/extensions/sources.md +++ b/docs/extensions/sources.md @@ -32,6 +32,6 @@ new ReadableStream( new SourceComposite([ new ControllableStream(), { start: (controller) => controller.enqueue() }, - ]) + ]), ) ``` diff --git a/packages/stream-assert/CHANGELOG.md b/packages/stream-assert/CHANGELOG.md index cbca8138b..6d9c1e222 100644 --- a/packages/stream-assert/CHANGELOG.md +++ b/packages/stream-assert/CHANGELOG.md @@ -2,64 +2,56 @@ ## [1.1.0](https://github.com/jg-wright/stream/compare/stream-assert-v1.0.2...stream-assert-v1.1.0) (2026-05-28) - ### Features -* add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac)) - +- add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac)) ### Dependencies -* The following workspace dependencies were updated - * devDependencies - * @johngw/stream-test bumped from 2.0.1 to 2.1.0 - * peerDependencies - * @johngw/stream-test bumped from ^2.0.1 to ^2.1.0 +- The following workspace dependencies were updated + - devDependencies + - @johngw/stream-test bumped from 2.0.1 to 2.1.0 + - peerDependencies + - @johngw/stream-test bumped from ^2.0.1 to ^2.1.0 ## [1.0.2](https://github.com/jg-wright/stream/compare/stream-assert-v1.0.1...stream-assert-v1.0.2) (2026-05-27) - ### Bug Fixes -* correct peer dependency ([9256934](https://github.com/jg-wright/stream/commit/92569340e51c17caa4c33215b773c49b1ee111ee)) +- correct peer dependency ([9256934](https://github.com/jg-wright/stream/commit/92569340e51c17caa4c33215b773c49b1ee111ee)) ## [1.0.1](https://github.com/jg-wright/stream/compare/stream-assert-v1.0.0...stream-assert-v1.0.1) (2026-05-27) - ### Bug Fixes -* **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8)) - +- **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8)) ### Dependencies -* The following workspace dependencies were updated - * devDependencies - * @johngw/stream-test bumped from 2.0.0 to 2.0.1 - * peerDependencies - * @johngw/stream-test bumped from ^1.3.1 to ^2.0.1 +- The following workspace dependencies were updated + - devDependencies + - @johngw/stream-test bumped from 2.0.0 to 2.0.1 + - peerDependencies + - @johngw/stream-test bumped from ^1.3.1 to ^2.0.1 ## 1.0.0 (2026-05-27) - ### ⚠ BREAKING CHANGES -* Dropping bun support including stream-test-bun +- Dropping bun support including stream-test-bun ### Features -* add stream-assert library ([ad89d94](https://github.com/jg-wright/stream/commit/ad89d94a9a5bb973ca3ba7afe6e0ccab1f56e5d3)) - +- add stream-assert library ([ad89d94](https://github.com/jg-wright/stream/commit/ad89d94a9a5bb973ca3ba7afe6e0ccab1f56e5d3)) ### Miscellaneous Chores -* move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8)) - +- move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8)) ### Dependencies -* The following workspace dependencies were updated - * devDependencies - * @johngw/stream-test bumped from 1.3.1 to 2.0.0 - * peerDependencies - * @johngw/stream-test bumped from ^1.3.1 to ^2.0.0 +- The following workspace dependencies were updated + - devDependencies + - @johngw/stream-test bumped from 1.3.1 to 2.0.0 + - peerDependencies + - @johngw/stream-test bumped from ^1.3.1 to ^2.0.0 diff --git a/packages/stream-common/CHANGELOG.md b/packages/stream-common/CHANGELOG.md index 2294a10d4..3711d5a89 100644 --- a/packages/stream-common/CHANGELOG.md +++ b/packages/stream-common/CHANGELOG.md @@ -2,44 +2,39 @@ ## [2.1.0](https://github.com/jg-wright/stream/compare/stream-common-v2.0.1...stream-common-v2.1.0) (2026-05-28) - ### Features -* add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac)) +- add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac)) ## [2.0.1](https://github.com/jg-wright/stream/compare/stream-common-v2.0.0...stream-common-v2.0.1) (2026-05-27) - ### Bug Fixes -* **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8)) +- **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8)) ## [2.0.0](https://github.com/jg-wright/stream/compare/stream-common-v1.1.2...stream-common-v2.0.0) (2026-05-27) - ### ⚠ BREAKING CHANGES -* Dropping bun support including stream-test-bun +- Dropping bun support including stream-test-bun ### Features -* add sink and source guards ([020cd61](https://github.com/jg-wright/stream/commit/020cd6151b706c3875b586f8c4b2b5abc5b0a7b7)) -* add type testing ([845200a](https://github.com/jg-wright/stream/commit/845200aca03ab11e7af060e98251c96662dc11e8)) -* mono repo ([18faac6](https://github.com/jg-wright/stream/commit/18faac6902eb30bb626b00fdf1d1e2185a14b757)) -* **subject:** multiple controllers ([c1bde5f](https://github.com/jg-wright/stream/commit/c1bde5f84e554d3b1c3a1c43d0a0075a7840863f)) -* **when:** curry ([8b1d57b](https://github.com/jg-wright/stream/commit/8b1d57b01fb4484af1e686a17bb94118458523bf)) - +- add sink and source guards ([020cd61](https://github.com/jg-wright/stream/commit/020cd6151b706c3875b586f8c4b2b5abc5b0a7b7)) +- add type testing ([845200a](https://github.com/jg-wright/stream/commit/845200aca03ab11e7af060e98251c96662dc11e8)) +- mono repo ([18faac6](https://github.com/jg-wright/stream/commit/18faac6902eb30bb626b00fdf1d1e2185a14b757)) +- **subject:** multiple controllers ([c1bde5f](https://github.com/jg-wright/stream/commit/c1bde5f84e554d3b1c3a1c43d0a0075a7840863f)) +- **when:** curry ([8b1d57b](https://github.com/jg-wright/stream/commit/8b1d57b01fb4484af1e686a17bb94118458523bf)) ### Bug Fixes -* add .js import extensions ([d746712](https://github.com/jg-wright/stream/commit/d746712e028901c39dc2aee758b8aa38fea4a94d)) -* attempt to fix for commonjs modules ([0e11625](https://github.com/jg-wright/stream/commit/0e11625204ed1366579ae143e5adc1facb15415b)) -* attempt to fix for commonjs modules ([b335622](https://github.com/jg-wright/stream/commit/b3356229dedd75088982d39300239da3e7a5125f)) -* correct exporting for commonjs ([2d6b082](https://github.com/jg-wright/stream/commit/2d6b082af37e0c41a9b536d8cd914b7c8a9d5040)) -* default import should be common ([13ef94c](https://github.com/jg-wright/stream/commit/13ef94ccb7b9e8bebb1f825187e191c67ec5388d)) -* make sure to use import extensions ([5d38b4c](https://github.com/jg-wright/stream/commit/5d38b4c43817ee9531f4f7ed6c7693ba2026e4fa)) - +- add .js import extensions ([d746712](https://github.com/jg-wright/stream/commit/d746712e028901c39dc2aee758b8aa38fea4a94d)) +- attempt to fix for commonjs modules ([0e11625](https://github.com/jg-wright/stream/commit/0e11625204ed1366579ae143e5adc1facb15415b)) +- attempt to fix for commonjs modules ([b335622](https://github.com/jg-wright/stream/commit/b3356229dedd75088982d39300239da3e7a5125f)) +- correct exporting for commonjs ([2d6b082](https://github.com/jg-wright/stream/commit/2d6b082af37e0c41a9b536d8cd914b7c8a9d5040)) +- default import should be common ([13ef94c](https://github.com/jg-wright/stream/commit/13ef94ccb7b9e8bebb1f825187e191c67ec5388d)) +- make sure to use import extensions ([5d38b4c](https://github.com/jg-wright/stream/commit/5d38b4c43817ee9531f4f7ed6c7693ba2026e4fa)) ### Miscellaneous Chores -* move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8)) +- move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8)) diff --git a/packages/stream-common/src/Test.ts b/packages/stream-common/src/Test.ts index 63f52b2ac..550759f75 100644 --- a/packages/stream-common/src/Test.ts +++ b/packages/stream-common/src/Test.ts @@ -14,7 +14,7 @@ import type { Test } from 'ts-toolbelt' * ``` */ export function check( - _debug?: Type + _debug?: Type, ): Equals, Outcome> { return 1 as Equals, Outcome> } diff --git a/packages/stream-jest/CHANGELOG.md b/packages/stream-jest/CHANGELOG.md index b27d3ac27..01637af41 100644 --- a/packages/stream-jest/CHANGELOG.md +++ b/packages/stream-jest/CHANGELOG.md @@ -2,76 +2,67 @@ ## [2.1.0](https://github.com/jg-wright/stream/compare/stream-jest-v2.0.2...stream-jest-v2.1.0) (2026-05-28) - ### Features -* add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac)) - +- add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac)) ### Dependencies -* The following workspace dependencies were updated - * devDependencies - * @johngw/stream-test bumped from 2.0.1 to 2.1.0 - * peerDependencies - * @johngw/stream-test bumped from ^2.0.1 to ^2.1.0 +- The following workspace dependencies were updated + - devDependencies + - @johngw/stream-test bumped from 2.0.1 to 2.1.0 + - peerDependencies + - @johngw/stream-test bumped from ^2.0.1 to ^2.1.0 ## [2.0.2](https://github.com/jg-wright/stream/compare/stream-jest-v2.0.1...stream-jest-v2.0.2) (2026-05-27) - ### Bug Fixes -* correct peer dependency ([9256934](https://github.com/jg-wright/stream/commit/92569340e51c17caa4c33215b773c49b1ee111ee)) +- correct peer dependency ([9256934](https://github.com/jg-wright/stream/commit/92569340e51c17caa4c33215b773c49b1ee111ee)) ## [2.0.1](https://github.com/jg-wright/stream/compare/stream-jest-v2.0.0...stream-jest-v2.0.1) (2026-05-27) - ### Bug Fixes -* **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8)) - +- **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8)) ### Dependencies -* The following workspace dependencies were updated - * devDependencies - * @johngw/stream-test bumped from 2.0.0 to 2.0.1 - * peerDependencies - * @johngw/stream-test bumped from ^1.3.1 to ^2.0.1 +- The following workspace dependencies were updated + - devDependencies + - @johngw/stream-test bumped from 2.0.0 to 2.0.1 + - peerDependencies + - @johngw/stream-test bumped from ^1.3.1 to ^2.0.1 ## [2.0.0](https://github.com/jg-wright/stream/compare/stream-jest-v1.0.3...stream-jest-v2.0.0) (2026-05-27) - ### ⚠ BREAKING CHANGES -* Dropping bun support including stream-test-bun +- Dropping bun support including stream-test-bun ### Features -* display timeline position on error ([e39319e](https://github.com/jg-wright/stream/commit/e39319e1341b411a6865320f6697b21f37159fc2)) -* mono repo ([18faac6](https://github.com/jg-wright/stream/commit/18faac6902eb30bb626b00fdf1d1e2185a14b757)) -* **subject:** multiple controllers ([c1bde5f](https://github.com/jg-wright/stream/commit/c1bde5f84e554d3b1c3a1c43d0a0075a7840863f)) - +- display timeline position on error ([e39319e](https://github.com/jg-wright/stream/commit/e39319e1341b411a6865320f6697b21f37159fc2)) +- mono repo ([18faac6](https://github.com/jg-wright/stream/commit/18faac6902eb30bb626b00fdf1d1e2185a14b757)) +- **subject:** multiple controllers ([c1bde5f](https://github.com/jg-wright/stream/commit/c1bde5f84e554d3b1c3a1c43d0a0075a7840863f)) ### Bug Fixes -* add .js import extensions ([d746712](https://github.com/jg-wright/stream/commit/d746712e028901c39dc2aee758b8aa38fea4a94d)) -* attempt to fix for commonjs modules ([0e11625](https://github.com/jg-wright/stream/commit/0e11625204ed1366579ae143e5adc1facb15415b)) -* attempt to fix for commonjs modules ([b335622](https://github.com/jg-wright/stream/commit/b3356229dedd75088982d39300239da3e7a5125f)) -* correct exporting for commonjs ([2d6b082](https://github.com/jg-wright/stream/commit/2d6b082af37e0c41a9b536d8cd914b7c8a9d5040)) -* correct test item type ([3cd17bd](https://github.com/jg-wright/stream/commit/3cd17bd472b31a06590c96b05f0ec50b3638ae14)) -* default import should be common ([13ef94c](https://github.com/jg-wright/stream/commit/13ef94ccb7b9e8bebb1f825187e191c67ec5388d)) - +- add .js import extensions ([d746712](https://github.com/jg-wright/stream/commit/d746712e028901c39dc2aee758b8aa38fea4a94d)) +- attempt to fix for commonjs modules ([0e11625](https://github.com/jg-wright/stream/commit/0e11625204ed1366579ae143e5adc1facb15415b)) +- attempt to fix for commonjs modules ([b335622](https://github.com/jg-wright/stream/commit/b3356229dedd75088982d39300239da3e7a5125f)) +- correct exporting for commonjs ([2d6b082](https://github.com/jg-wright/stream/commit/2d6b082af37e0c41a9b536d8cd914b7c8a9d5040)) +- correct test item type ([3cd17bd](https://github.com/jg-wright/stream/commit/3cd17bd472b31a06590c96b05f0ec50b3638ae14)) +- default import should be common ([13ef94c](https://github.com/jg-wright/stream/commit/13ef94ccb7b9e8bebb1f825187e191c67ec5388d)) ### Miscellaneous Chores -* move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8)) - +- move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8)) ### Dependencies -* The following workspace dependencies were updated - * devDependencies - * @johngw/stream-test bumped from 1.3.1 to 2.0.0 - * peerDependencies - * @johngw/stream-test bumped from ^1.3.1 to ^2.0.0 +- The following workspace dependencies were updated + - devDependencies + - @johngw/stream-test bumped from 1.3.1 to 2.0.0 + - peerDependencies + - @johngw/stream-test bumped from ^1.3.1 to ^2.0.0 diff --git a/packages/stream-test/CHANGELOG.md b/packages/stream-test/CHANGELOG.md index a150a2d31..1fbee8f7c 100644 --- a/packages/stream-test/CHANGELOG.md +++ b/packages/stream-test/CHANGELOG.md @@ -2,72 +2,64 @@ ## [2.1.0](https://github.com/jg-wright/stream/compare/stream-test-v2.0.1...stream-test-v2.1.0) (2026-05-28) - ### Features -* add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac)) - +- add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac)) ### Dependencies -* The following workspace dependencies were updated - * dependencies - * @johngw/stream-common bumped from 2.0.1 to 2.1.0 +- The following workspace dependencies were updated + - dependencies + - @johngw/stream-common bumped from 2.0.1 to 2.1.0 ## [2.0.1](https://github.com/jg-wright/stream/compare/stream-test-v2.0.0...stream-test-v2.0.1) (2026-05-27) - ### Bug Fixes -* **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8)) - +- **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8)) ### Dependencies -* The following workspace dependencies were updated - * dependencies - * @johngw/stream-common bumped from 2.0.0 to 2.0.1 +- The following workspace dependencies were updated + - dependencies + - @johngw/stream-common bumped from 2.0.0 to 2.0.1 ## [2.0.0](https://github.com/jg-wright/stream/compare/stream-test-v1.3.1...stream-test-v2.0.0) (2026-05-27) - ### ⚠ BREAKING CHANGES -* Dropping bun support including stream-test-bun +- Dropping bun support including stream-test-bun ### Features -* add type testing ([845200a](https://github.com/jg-wright/stream/commit/845200aca03ab11e7af060e98251c96662dc11e8)) -* mono repo ([18faac6](https://github.com/jg-wright/stream/commit/18faac6902eb30bb626b00fdf1d1e2185a14b757)) -* pass timeline to test expectation ([f950af3](https://github.com/jg-wright/stream/commit/f950af3864fd997b20a9473afcc6aec437d42adf)) -* **subject:** multiple controllers ([c1bde5f](https://github.com/jg-wright/stream/commit/c1bde5f84e554d3b1c3a1c43d0a0075a7840863f)) -* **test:** provide timeline instances ([ba88064](https://github.com/jg-wright/stream/commit/ba880641941e3a29aaa9a7eb7917ce32642baa5a)) -* **test:** provide timeline instances ([22e6f7a](https://github.com/jg-wright/stream/commit/22e6f7a538edbff744f70a4db48ce44c2d0ebac2)) -* timeline boolean and null shorthands ([653a7bb](https://github.com/jg-wright/stream/commit/653a7bb43eb34ec3ef36c4d72e35b1f3ab7a465e)) -* timeline error positional displays ([cb39290](https://github.com/jg-wright/stream/commit/cb392907cd8698bf4eea5758de840ec41bc5fd3e)) -* timeline error positional displays ([0a2d360](https://github.com/jg-wright/stream/commit/0a2d360a87f0291a56100c5ebef1e33a8a82940e)) - +- add type testing ([845200a](https://github.com/jg-wright/stream/commit/845200aca03ab11e7af060e98251c96662dc11e8)) +- mono repo ([18faac6](https://github.com/jg-wright/stream/commit/18faac6902eb30bb626b00fdf1d1e2185a14b757)) +- pass timeline to test expectation ([f950af3](https://github.com/jg-wright/stream/commit/f950af3864fd997b20a9473afcc6aec437d42adf)) +- **subject:** multiple controllers ([c1bde5f](https://github.com/jg-wright/stream/commit/c1bde5f84e554d3b1c3a1c43d0a0075a7840863f)) +- **test:** provide timeline instances ([ba88064](https://github.com/jg-wright/stream/commit/ba880641941e3a29aaa9a7eb7917ce32642baa5a)) +- **test:** provide timeline instances ([22e6f7a](https://github.com/jg-wright/stream/commit/22e6f7a538edbff744f70a4db48ce44c2d0ebac2)) +- timeline boolean and null shorthands ([653a7bb](https://github.com/jg-wright/stream/commit/653a7bb43eb34ec3ef36c4d72e35b1f3ab7a465e)) +- timeline error positional displays ([cb39290](https://github.com/jg-wright/stream/commit/cb392907cd8698bf4eea5758de840ec41bc5fd3e)) +- timeline error positional displays ([0a2d360](https://github.com/jg-wright/stream/commit/0a2d360a87f0291a56100c5ebef1e33a8a82940e)) ### Bug Fixes -* add .js import extensions ([d746712](https://github.com/jg-wright/stream/commit/d746712e028901c39dc2aee758b8aa38fea4a94d)) -* attempt to fix for commonjs modules ([0e11625](https://github.com/jg-wright/stream/commit/0e11625204ed1366579ae143e5adc1facb15415b)) -* attempt to fix for commonjs modules ([b335622](https://github.com/jg-wright/stream/commit/b3356229dedd75088982d39300239da3e7a5125f)) -* correct exporting for commonjs ([2d6b082](https://github.com/jg-wright/stream/commit/2d6b082af37e0c41a9b536d8cd914b7c8a9d5040)) -* correct test item type ([3cd17bd](https://github.com/jg-wright/stream/commit/3cd17bd472b31a06590c96b05f0ec50b3638ae14)) -* default import should be common ([13ef94c](https://github.com/jg-wright/stream/commit/13ef94ccb7b9e8bebb1f825187e191c67ec5388d)) -* force deployment ([9d5b85d](https://github.com/jg-wright/stream/commit/9d5b85d0187e278bd279a20e92c43b8f36997f76)) -* make sure to use import extensions ([5d38b4c](https://github.com/jg-wright/stream/commit/5d38b4c43817ee9531f4f7ed6c7693ba2026e4fa)) -* timers ([638fdab](https://github.com/jg-wright/stream/commit/638fdabb642bb4a9f5cfbaf9d1c272fc8de80a9b)) - +- add .js import extensions ([d746712](https://github.com/jg-wright/stream/commit/d746712e028901c39dc2aee758b8aa38fea4a94d)) +- attempt to fix for commonjs modules ([0e11625](https://github.com/jg-wright/stream/commit/0e11625204ed1366579ae143e5adc1facb15415b)) +- attempt to fix for commonjs modules ([b335622](https://github.com/jg-wright/stream/commit/b3356229dedd75088982d39300239da3e7a5125f)) +- correct exporting for commonjs ([2d6b082](https://github.com/jg-wright/stream/commit/2d6b082af37e0c41a9b536d8cd914b7c8a9d5040)) +- correct test item type ([3cd17bd](https://github.com/jg-wright/stream/commit/3cd17bd472b31a06590c96b05f0ec50b3638ae14)) +- default import should be common ([13ef94c](https://github.com/jg-wright/stream/commit/13ef94ccb7b9e8bebb1f825187e191c67ec5388d)) +- force deployment ([9d5b85d](https://github.com/jg-wright/stream/commit/9d5b85d0187e278bd279a20e92c43b8f36997f76)) +- make sure to use import extensions ([5d38b4c](https://github.com/jg-wright/stream/commit/5d38b4c43817ee9531f4f7ed6c7693ba2026e4fa)) +- timers ([638fdab](https://github.com/jg-wright/stream/commit/638fdabb642bb4a9f5cfbaf9d1c272fc8de80a9b)) ### Miscellaneous Chores -* move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8)) - +- move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8)) ### Dependencies -* The following workspace dependencies were updated - * dependencies - * @johngw/stream-common bumped from 1.1.2 to 2.0.0 +- The following workspace dependencies were updated + - dependencies + - @johngw/stream-common bumped from 1.1.2 to 2.0.0 diff --git a/packages/stream/CHANGELOG.md b/packages/stream/CHANGELOG.md index a3b4bc0bf..a50975800 100644 --- a/packages/stream/CHANGELOG.md +++ b/packages/stream/CHANGELOG.md @@ -2,92 +2,83 @@ ## [4.1.0](https://github.com/jg-wright/stream/compare/stream-v4.0.2...stream-v4.1.0) (2026-05-28) - ### Features -* add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac)) - +- add tapWhen and WritableReadablePair ([f40843a](https://github.com/jg-wright/stream/commit/f40843af08730d917fab5496581fb0794e5894ac)) ### Dependencies -* The following workspace dependencies were updated - * dependencies - * @johngw/stream-common bumped from ^2.0.1 to ^2.1.0 - * devDependencies - * @johngw/stream-assert bumped from 1.0.2 to 1.1.0 - * @johngw/stream-test bumped from 2.0.1 to 2.1.0 +- The following workspace dependencies were updated + - dependencies + - @johngw/stream-common bumped from ^2.0.1 to ^2.1.0 + - devDependencies + - @johngw/stream-assert bumped from 1.0.2 to 1.1.0 + - @johngw/stream-test bumped from 2.0.1 to 2.1.0 ## [4.0.2](https://github.com/jg-wright/stream/compare/stream-v4.0.1...stream-v4.0.2) (2026-05-27) - ### Dependencies -* The following workspace dependencies were updated - * devDependencies - * @johngw/stream-assert bumped from 1.0.1 to 1.0.2 +- The following workspace dependencies were updated + - devDependencies + - @johngw/stream-assert bumped from 1.0.1 to 1.0.2 ## [4.0.1](https://github.com/jg-wright/stream/compare/stream-v4.0.0...stream-v4.0.1) (2026-05-27) - ### Bug Fixes -* **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8)) - +- **release:** add required provenance property ([ca55c15](https://github.com/jg-wright/stream/commit/ca55c150419279e0b55fe061903ae200b64a5ae8)) ### Dependencies -* The following workspace dependencies were updated - * dependencies - * @johngw/stream-common bumped from ^2.0.0 to ^2.0.1 - * devDependencies - * @johngw/stream-assert bumped from 1.0.0 to 1.0.1 - * @johngw/stream-test bumped from 2.0.0 to 2.0.1 +- The following workspace dependencies were updated + - dependencies + - @johngw/stream-common bumped from ^2.0.0 to ^2.0.1 + - devDependencies + - @johngw/stream-assert bumped from 1.0.0 to 1.0.1 + - @johngw/stream-test bumped from 2.0.0 to 2.0.1 ## [4.0.0](https://github.com/jg-wright/stream/compare/stream-v3.1.0...stream-v4.0.0) (2026-05-27) - ### ⚠ BREAKING CHANGES -* Dropping bun support including stream-test-bun -* **subject:** You must control a subject with the `control()` method. +- Dropping bun support including stream-test-bun +- **subject:** You must control a subject with the `control()` method. ### Features -* add sink and source guards ([020cd61](https://github.com/jg-wright/stream/commit/020cd6151b706c3875b586f8c4b2b5abc5b0a7b7)) -* add type testing ([845200a](https://github.com/jg-wright/stream/commit/845200aca03ab11e7af060e98251c96662dc11e8)) -* configurable subject transformers ([8d6299b](https://github.com/jg-wright/stream/commit/8d6299b7d3f3de0c0180ba3770eff8bb49572d9d)) -* mono repo ([18faac6](https://github.com/jg-wright/stream/commit/18faac6902eb30bb626b00fdf1d1e2185a14b757)) -* **of:** add of source ([bfc66a8](https://github.com/jg-wright/stream/commit/bfc66a81b55288aa6c976a819e6e14009461ea3d)) -* stream object entries ([948c3b4](https://github.com/jg-wright/stream/commit/948c3b45584655da4da3b1ff02e35c87833698eb)) -* **subject:** multiple controllers ([c1bde5f](https://github.com/jg-wright/stream/commit/c1bde5f84e554d3b1c3a1c43d0a0075a7840863f)) -* **subject:** multiple controllers ([5098b15](https://github.com/jg-wright/stream/commit/5098b1538b4f671e762cd97c5a906657999e9909)) - +- add sink and source guards ([020cd61](https://github.com/jg-wright/stream/commit/020cd6151b706c3875b586f8c4b2b5abc5b0a7b7)) +- add type testing ([845200a](https://github.com/jg-wright/stream/commit/845200aca03ab11e7af060e98251c96662dc11e8)) +- configurable subject transformers ([8d6299b](https://github.com/jg-wright/stream/commit/8d6299b7d3f3de0c0180ba3770eff8bb49572d9d)) +- mono repo ([18faac6](https://github.com/jg-wright/stream/commit/18faac6902eb30bb626b00fdf1d1e2185a14b757)) +- **of:** add of source ([bfc66a8](https://github.com/jg-wright/stream/commit/bfc66a81b55288aa6c976a819e6e14009461ea3d)) +- stream object entries ([948c3b4](https://github.com/jg-wright/stream/commit/948c3b45584655da4da3b1ff02e35c87833698eb)) +- **subject:** multiple controllers ([c1bde5f](https://github.com/jg-wright/stream/commit/c1bde5f84e554d3b1c3a1c43d0a0075a7840863f)) +- **subject:** multiple controllers ([5098b15](https://github.com/jg-wright/stream/commit/5098b1538b4f671e762cd97c5a906657999e9909)) ### Bug Fixes -* add .js import extensions ([d746712](https://github.com/jg-wright/stream/commit/d746712e028901c39dc2aee758b8aa38fea4a94d)) -* attempt to fix for commonjs modules ([0e11625](https://github.com/jg-wright/stream/commit/0e11625204ed1366579ae143e5adc1facb15415b)) -* attempt to fix for commonjs modules ([b335622](https://github.com/jg-wright/stream/commit/b3356229dedd75088982d39300239da3e7a5125f)) -* **buffercount:** enqueue at correct time ([7f7c999](https://github.com/jg-wright/stream/commit/7f7c999a6fce4551eccd689f90725896b09f9f6f)) -* correct exporting for commonjs ([2d6b082](https://github.com/jg-wright/stream/commit/2d6b082af37e0c41a9b536d8cd914b7c8a9d5040)) -* default import should be common ([13ef94c](https://github.com/jg-wright/stream/commit/13ef94ccb7b9e8bebb1f825187e191c67ec5388d)) -* export missing classes ([d417034](https://github.com/jg-wright/stream/commit/d41703427158ff6201bf564ae077c56671a36946)) -* forkable underlying sinks ([e268d95](https://github.com/jg-wright/stream/commit/e268d95a9b85e0ac0fa68f015394fda205983737)) -* make sure to use import extensions ([5d38b4c](https://github.com/jg-wright/stream/commit/5d38b4c43817ee9531f4f7ed6c7693ba2026e4fa)) -* stream tag ([f4f727a](https://github.com/jg-wright/stream/commit/f4f727a1dc5934258676bd58bbdb5a596eb0b257)) -* **stream:** full name imports only ([7f58fb9](https://github.com/jg-wright/stream/commit/7f58fb93ae3f94ceb83931fb59510f94207ecae2)) - +- add .js import extensions ([d746712](https://github.com/jg-wright/stream/commit/d746712e028901c39dc2aee758b8aa38fea4a94d)) +- attempt to fix for commonjs modules ([0e11625](https://github.com/jg-wright/stream/commit/0e11625204ed1366579ae143e5adc1facb15415b)) +- attempt to fix for commonjs modules ([b335622](https://github.com/jg-wright/stream/commit/b3356229dedd75088982d39300239da3e7a5125f)) +- **buffercount:** enqueue at correct time ([7f7c999](https://github.com/jg-wright/stream/commit/7f7c999a6fce4551eccd689f90725896b09f9f6f)) +- correct exporting for commonjs ([2d6b082](https://github.com/jg-wright/stream/commit/2d6b082af37e0c41a9b536d8cd914b7c8a9d5040)) +- default import should be common ([13ef94c](https://github.com/jg-wright/stream/commit/13ef94ccb7b9e8bebb1f825187e191c67ec5388d)) +- export missing classes ([d417034](https://github.com/jg-wright/stream/commit/d41703427158ff6201bf564ae077c56671a36946)) +- forkable underlying sinks ([e268d95](https://github.com/jg-wright/stream/commit/e268d95a9b85e0ac0fa68f015394fda205983737)) +- make sure to use import extensions ([5d38b4c](https://github.com/jg-wright/stream/commit/5d38b4c43817ee9531f4f7ed6c7693ba2026e4fa)) +- stream tag ([f4f727a](https://github.com/jg-wright/stream/commit/f4f727a1dc5934258676bd58bbdb5a596eb0b257)) +- **stream:** full name imports only ([7f58fb9](https://github.com/jg-wright/stream/commit/7f58fb93ae3f94ceb83931fb59510f94207ecae2)) ### Miscellaneous Chores -* move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8)) - +- move to node.js ([6c9aca5](https://github.com/jg-wright/stream/commit/6c9aca5eadc743553e104218ca146658244cd0b8)) ### Dependencies -* The following workspace dependencies were updated - * dependencies - * @johngw/stream-common bumped from ^1.1.2 to ^2.0.0 - * devDependencies - * @johngw/stream-assert bumped from 0.0.0 to 1.0.0 - * @johngw/stream-test bumped from 1.3.1 to 2.0.0 +- The following workspace dependencies were updated + - dependencies + - @johngw/stream-common bumped from ^1.1.2 to ^2.0.0 + - devDependencies + - @johngw/stream-assert bumped from 0.0.0 to 1.0.0 + - @johngw/stream-test bumped from 1.3.1 to 2.0.0 diff --git a/packages/stream/src/sinks/toIterator.ts b/packages/stream/src/sinks/toIterator.ts index 8ef1ce4d5..89b09c175 100644 --- a/packages/stream/src/sinks/toIterator.ts +++ b/packages/stream/src/sinks/toIterator.ts @@ -25,7 +25,7 @@ export interface ToIteratorOptions { */ export function toIterator( stream: ReadableStream, - options?: ToIteratorOptions + options?: ToIteratorOptions, ): AsyncIterator { return new StreamIterator(stream, options?.signal) } diff --git a/packages/stream/src/sources/Controllable.ts b/packages/stream/src/sources/Controllable.ts index 27f84913f..fbe78c2da 100644 --- a/packages/stream/src/sources/Controllable.ts +++ b/packages/stream/src/sources/Controllable.ts @@ -28,5 +28,4 @@ export interface ControllerPullListener { * @group Sources */ export interface ControllableReadableStream - extends ReadableStream, - Controllable {} + extends ReadableStream, Controllable {} diff --git a/packages/stream/src/sources/interval.ts b/packages/stream/src/sources/interval.ts index c2fba1342..e4ccf0c17 100644 --- a/packages/stream/src/sources/interval.ts +++ b/packages/stream/src/sources/interval.ts @@ -24,6 +24,6 @@ export function interval(ms: number, queuingStrategy?: QueuingStrategy) { clearInterval(timer) }, }, - queuingStrategy + queuingStrategy, ) } diff --git a/packages/stream/src/sources/race.ts b/packages/stream/src/sources/race.ts index ce455e664..3b960283b 100644 --- a/packages/stream/src/sources/race.ts +++ b/packages/stream/src/sources/race.ts @@ -18,7 +18,7 @@ import { immediatelyClosingReadableStream } from '@johngw/stream-common/Stream' */ export function race( streams: ReadableStream[], - queuingStrategy?: QueuingStrategy + queuingStrategy?: QueuingStrategy, ) { if (!streams.length) return immediatelyClosingReadableStream() @@ -30,7 +30,7 @@ export function race( return Promise.race(readers.map((reader) => reader.read())).then( (result) => result.done ? controller.close() : controller.enqueue(result.value), - (error) => controller.error(error) + (error) => controller.error(error), ) }, @@ -38,6 +38,6 @@ export function race( await all(readers, (reader) => reader.cancel(reason)) }, }, - queuingStrategy + queuingStrategy, ) } diff --git a/packages/stream/src/storages/StorageCache.ts b/packages/stream/src/storages/StorageCache.ts index a512d0a0d..5084e9735 100644 --- a/packages/stream/src/storages/StorageCache.ts +++ b/packages/stream/src/storages/StorageCache.ts @@ -74,8 +74,8 @@ export class StorageCache { Object.entries(this.getAll()).reduce( (acc, [key, value]) => this.#keyMatches(pathKey, key) ? acc : { ...acc, [key]: value }, - {} - ) + {}, + ), ) } @@ -94,7 +94,7 @@ export class StorageCache { async updateIfStale( path: string[], update: () => unknown | Promise, - ms?: number + ms?: number, ) { let item = this.get(path) if (item === undefined) { diff --git a/packages/stream/src/transformers/bufferCount.ts b/packages/stream/src/transformers/bufferCount.ts index c7e675030..3add05a3b 100644 --- a/packages/stream/src/transformers/bufferCount.ts +++ b/packages/stream/src/transformers/bufferCount.ts @@ -15,7 +15,7 @@ export function bufferCount(length: number) { if (length < 1) throw new Error( - `bufferCount() cannot be used with a count less than one. Got "${length}".` + `bufferCount() cannot be used with a count less than one. Got "${length}".`, ) if (!isFinite(length)) @@ -23,7 +23,7 @@ export function bufferCount(length: number) { if (Math.round(length) !== length) throw new Error( - `bufferCount() cannot be used with a floating point length. Got "${length}".` + `bufferCount() cannot be used with a floating point length. Got "${length}".`, ) let buffer: T[] = [] diff --git a/packages/stream/src/transformers/filter.ts b/packages/stream/src/transformers/filter.ts index 62a306288..9a0430768 100644 --- a/packages/stream/src/transformers/filter.ts +++ b/packages/stream/src/transformers/filter.ts @@ -23,7 +23,7 @@ import type { Predicate } from '@johngw/stream-common/Function' * ``` */ export function filter( - predicate: (chunk: In) => chunk is Out + predicate: (chunk: In) => chunk is Out, ): TransformStream export function filter(predicate: Predicate): TransformStream diff --git a/packages/stream/src/transformers/find.ts b/packages/stream/src/transformers/find.ts index 04ab5f8cb..c52182aca 100644 --- a/packages/stream/src/transformers/find.ts +++ b/packages/stream/src/transformers/find.ts @@ -26,7 +26,7 @@ import type { Predicate } from '@johngw/stream-common/Function' * ``` */ export function find( - predicate: (chunk: In) => chunk is Out + predicate: (chunk: In) => chunk is Out, ): TransformStream export function find(predicate: Predicate): TransformStream diff --git a/packages/stream/src/transformers/interpose.ts b/packages/stream/src/transformers/interpose.ts index 3d6adb817..03c7ee612 100644 --- a/packages/stream/src/transformers/interpose.ts +++ b/packages/stream/src/transformers/interpose.ts @@ -13,7 +13,7 @@ * ``` */ export function interpose( - promise: Promise | ((chunk: T) => Promise) + promise: Promise | ((chunk: T) => Promise), ) { const fn = typeof promise === 'function' ? promise : () => promise diff --git a/packages/stream/src/transformers/reduce.ts b/packages/stream/src/transformers/reduce.ts index 05c8e4c21..b8c766144 100644 --- a/packages/stream/src/transformers/reduce.ts +++ b/packages/stream/src/transformers/reduce.ts @@ -18,14 +18,14 @@ import { type Flushable, pipeFlushes } from '@johngw/stream-common/Stream' export function reduce( acc: O, fn: Accumulator, - options?: Flushable + options?: Flushable, ) { return new TransformStream({ start(controller) { pipeFlushes( () => controller.enqueue(acc), (error) => controller.error(error), - options + options, ) },