10 KiB
10 KiB
Changelog
Tags:
- 💥 Breaking Change
- 👓 Spec Compliance
- 🚀 New Feature
- 🐛 Bug Fix
- 👎 Deprecation
- 📝 Documentation
- 🏠 Internal
- 💅 Polish
v3.2.0 (2021-11-06)
- 👎 Deprecate
WritableStreamDefaultController.abortReason
(#102)- Use
WritableStreamDefaultController.signal.reason
instead.
- Use
- 👓 Align with spec version
4b6b93c
(#103)
v3.1.1 (2021-09-06)
v3.1.0 (2021-07-21)
- 🚀 Calling
ReadableStream.tee()
on a readable byte stream now returns two readable byte streams. (#81) - 🚀 Add
WritableStreamDefaultController.signal
and.abortReason
. (#81).signal
requires a globalAbortController
constructor to be available. If necessary, use a polyfill.
- 🐛 Make sure streams created with a different version of the polyfill do not pass the brand checks. (#75, #77)
- 👓 Align with spec version
cada812
(#79, #81)
v3.0.3 (2021-04-09)
- 💅 Change
Promise<void>
toPromise<undefined>
in TypeScript type definitions (#72) - 🐛 Fix
ReadableStream.tee()
resolving itscancel()
promise too early (#73) - 👓 Align with spec version
6762cdb
(#73)
v3.0.2 (2021-02-10)
- 👓 Align with spec version
200c971
(#69)
v3.0.1 (2020-11-12)
- 📝 Add documentation to type definitions (#62)
- 👓 Align with spec version
6cd5e81
(#63) - 🐛 Fix an issue where the polyfill could throw an error when resolving/rejecting
reader.closed
when it was already resolved/rejected (#66, #67)
v3.0.0 (2020-07-20)
- 💥 Align with spec version
62fe4c8
(#52, #57, #59)
This includes the following breaking changes:- All classes are now exposed globally. Concretely, this adds the following classes:
ReadableStreamDefaultController
ReadableByteStreamController
ReadableStreamBYOBRequest
ReadableStreamDefaultReader
ReadableStreamBYOBReader
WritableStreamDefaultController
WritableStreamDefaultWriter
TransformStreamDefaultController
ReadableStream.getIterator()
is renamed toReadableStream.values()
ReadableByteStreamController.byobRequest
can benull
(instead ofundefined
) if there is no current BYOB request.ReadableStreamBYOBRequest.view
can benull
(instead ofundefined
) if the BYOB request has already been responded to.- Constructors and methods have stricter type checking for object arguments. For example,
new ReadableStream(null)
would previously behave likenew ReadableStream({})
, but now it throws aTypeError
instead. - Some constructors and methods may throw slightly different errors when given invalid arguments.
- Various byte-stream-related APIs now prohibit zero-length views or buffers.
- The async iterator of a
ReadableStream
now behaves more like an async generator, e.g. returning promises fulfilled with{ value: undefined, done: true }
afterreturn()
ing the iterator, instead of returning a rejected promise.
- All classes are now exposed globally. Concretely, this adds the following classes:
- 💥 Updated TypeScript types to align with new specification (#60)
While these are technically breaking changes, you should only be affected if you manually reference these types from your code.PipeOptions
is renamed toStreamPipeOptions
ReadResult
is replaced byReadableStreamDefaultReadResult
andReadableStreamBYOBReadResult
ReadableStreamDefaultControllerCallback
is replaced byUnderlyingSourceStartCallback
andUnderlyingSourcePullCallback
ReadableByteStreamControllerCallback
is replaced byUnderlyingByteSourceStartCallback
andUnderlyingByteSourcePullCallback
ReadableStreamErrorCallback
is renamed toUnderlyingSourceCancelCallback
WritableStreamDefaultControllerStartCallback
is renamed toUnderlyingSinkStartCallback
WritableStreamDefaultControllerWriteCallback
is renamed toUnderlyingSinkWriteCallback
WritableStreamDefaultControllerCloseCallback
is renamed toUnderlyingSinkCloseCallback
WritableStreamErrorCallback
is renamed toUnderlyingSinkAbortCallback
TransformStreamDefaultControllerCallback
is replaced byTransformerStartCallback
andTransformerFlushCallback
TransformStreamDefaultControllerTransformCallback
is renamed toTransformerTransformCallback
v2.1.1 (2020-04-11)
v2.1.0 (2020-02-23)
- 👓 Align with spec version
ed00d2f
(#43, #44) - 🏠 Down-level type definitions for older TypeScript versions. (#41)
v2.0.6 (2019-11-08)
v2.0.5 (2019-10-08)
- 👓 Align with spec version
ae5e0cb
(#33) - 🐛 Fix support for non-browser environments, such as Node.
v2.0.4 (2019-08-01)
- 🐛 Fix pipe not aborting when both
preventAbort
andpreventCancel
are set (#31) - 👓 Align with spec version
e4d3b1a
(#31)
v2.0.3 (2019-04-04)
- 👓 Align with spec version
6f94580
(#21) - 🏠 Run web platform tests on ES5 variant (#19)
v2.0.2 (2019-03-17)
v2.0.1 (2019-03-16)
v2.0.0 (2019-03-10)
-
💥 Ownership change: @mattiasbuelens/web-streams-polyfill has been republished as web-streams-polyfill. For the full list of changes between web-streams-polyfill v1.3.2 and this version, visit the fork's changelog.
-
💥 CommonJS entry points have been moved to
dist/
:index.js
➡dist/polyfill.js
index.es6.js
➡dist/polyfill.es6.js
However, we recommend migrating to a variant sub-package instead:
require('web-streams-polyfill/index.js')
➡require('web-streams-polyfill')
require('web-streams-polyfill/index.es6.js')
➡require('web-streams-polyfill/es6')
-
👓 Align with spec version
2c8f35e
-
🏠 Code moved from creatorrr/web-streams-polyfill to MattiasBuelens/web-streams-polyfill