Add queuing strategy option for Stream.toReadableStream

[mattrossman]

Type

• Refactor
• Feature
• Bug Fix
• Optimization
• Documentation Update

Description

Adds a "strategy" option to

• Stream.toReadableStream
• Stream.toReadableStreamEffect
• Stream.toReadableStreamRuntime

This allows configuring the queuing strategy of the underlying ReadableStream.

// Default queuing strategy
stream.pipe(Stream.toReadableStream)

// Custom queuing strategies
stream.pipe(Stream.toReadableStream({ strategy: { highWaterMark: 2 } }))
stream.pipe(Stream.toReadableStream({ strategy: new CountQueuingStrategy({ highWaterMark: 2 }) }))

The name "strategy" was chosen to align with the Streams spec and TypeScript lib types.

References:

• https://streams.spec.whatwg.org/#rs-prototype
• https://github.com/microsoft/TypeScript/blob/af3a61fe4487a92d59f9479aa4249d897b91af14/src/lib/dom.generated.d.ts#L18794-L18799

Note the diff for this PR shows many lines changed in toReadableStreamRuntime, these are mostly formatting changes incurred by the extra level of indentation from the expanded signature. The main real changes there are:

• the ReadableStream constructor receives a second argument passed down via options?.strategy
• the first argument of dual() has been changed from an arity of 2 to an isStream predicate matching other configurable stream functions

Related

• Closes Accept ReadableStream queuingStrategy in Stream.toReadableStream #2840

[changeset-bot]

🦋 Changeset detected

Latest commit: f730c1a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 24 packages

Name	Type
effect	Minor
@effect/cli	Major
@effect/experimental	Major
@effect/opentelemetry	Major
@effect/platform-browser	Major
@effect/platform-bun	Major
@effect/platform-node-shared	Major
@effect/platform-node	Major
@effect/platform	Major
@effect/printer-ansi	Major
@effect/printer	Major
@effect/rpc-http	Major
@effect/rpc	Major
@effect/schema	Major
@effect/sql-mssql	Major
@effect/sql-mysql2	Major
@effect/sql-pg	Major
@effect/sql-sqlite-bun	Major
@effect/sql-sqlite-node	Major
@effect/sql-sqlite-react-native	Major
@effect/sql-sqlite-wasm	Major
@effect/sql	Major
@effect/typeclass	Major
@effect/vitest	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[tim-smart]

Looks good, just one small change.