- Fix promise returned from
pushfunction not resolving when using a buffer.
- Add export maps to package.json files for the TypeScript
nodenext
- Fixed memory leaks in static combinator functions race, merge, zip and latest due to Promise.race.
- Fixed missing file in package.json.
- Fixed throw method not catching promises in newer versions of v8 (node.js 12+).
- Added ESM support for newer versions of node.
- build files with target set to es5 rather than esnext
- build files with target set to es5 rather than esnext
- build files with target set to es5 rather than esnext
- build files with target set to es5 rather than esnext
- upgrade dependencies
- upgrade dependencies
- upgrade dependencies
This release overhauls the push and stop promises and the return and throw methods to be more in line with the behavior of async generators. If you used repeaters to simply add and remove event handlers, you can upgrade without worrying about breaking changes. However, if you awaited push calls, read the value of the stop promise, or used the return or throw methods in non-trivial ways, this release may break your code.
-
Previously, the n-th call to
pushresolved to the value passed to the n-th call toRepeater.prototype.next. This was inaccurate insofar as async generators resume the n-thyieldwith the value passed to the n+1-th call tonext. Additionally, async generators completely ignore the first value passed tonextentirely. The former behavior of repeaters was confusing insofar as the first call topushwould always resolve immediately, becausepushcould not be called untilnextwas called for the first time. In 3.0, the behavior has now been changed so that the n-th call topushresolves to the n+1-th call tonext.For the most part, code which awaits
pushwill work as expected, except when the code relied on the first call topushresolving immediately. To make sure you’re not relying on the old behavior ofpush, you should make sure that you await push at the bottom of loops, rather than the top. See the changes totimersas an example. -
Calling
Repeater.prototype.throwwill now cause the previouspushcall to reject, rather than simply stopping the repeater and throwing the error. This means errors thrown into repeaters are now recoverable. If you call push without awaiting or callingthen/catchon the returned promise and then call thethrowmethod, the repeater will rethrow the error, preserving the previous behavior. However, if you awaitpushor otherwise call thethenorcatchmethods, it becomes your responsibility to handle errors thrown in viathrowand stop the repeater. #43 -
The
stoppromise no longer resolves to the value passed toRepeater.prototype.return. Instead, it consistently fulfills toundefinedwhen the repeater is stopped. Additionally, callingRepeater.prototype.returnwill return a result whose value is always whatever was passed toreturn. In the case of premature returns, the return value of the executor is ignored unless it throws an error. #41This change was made because there is no way with async generators to inspect the value passed to return from within the async generator. Additionally, the only way to modify the result returned from the
returnmethod would be to put areturnstatement in afinallyblock within the async generator, which is typically considered to be a bad practice. Repeaters now uniformly return the value passed to thereturnmethod. See #40 for a longer explanation for why we made this change. -
Errors thrown by the executor now take priority over rejections passed to push. If a pushed promise rejects, the repeater will await the execution result and throw an error thrown by the executor instead of the rejected promise.
-
Changes to combinator methods
- Improved type inference for
Repeater.raceandRepeater.merge Repeater.mergeyields non-iterable values, so you can call merge on an iterable of promises to get an async iterator which produces values as each promise fulfills.- Iterables passed to combinator methods are upgraded to async iterators, so that promise-like values are awaited and unwrapped before being pushed to the repeater
- Improved type inference for
-
Changes to typescript typings:
Repeater,RepeaterExecutor,Pushand other related types now take the type parametersTReturnandTNextin line with typescript 3.6’s strict async generator typings.- The
RepeaterBufferinterface and concrete classes no longer accept a type parameter. All places where the type parameter would have been used,unknownis used instead. You should never directly add or remove values from buffers. - The typings of the
nextandreturnmethods have been changed to acceptPromiseLike<T>andPromiseLike<TReturn>respectively as parameters.
- Fixed build error in @repeaterjs/pubsub
- Fixed timers using the wrong version of @repeaterjs/repeater
- Fixed limiters using the wrong version of @repeaterjs/repeater
- Fixed pubsub using the wrong version of @repeaterjs/repeater.
- Renamed all instances of
ChanneltoRepeater(e.g.ChanneltoRepeater,ChannelBuffertoRepeaterBuffer). See #18 for the rationale behind this name change.
- Renamed all instances of
ChanneltoRepeater(e.g.ChanneltoRepeater,ChannelBuffertoRepeaterBuffer). See #18 for the rationale behind this name change.
- Renamed all instances of
ChanneltoRepeater(e.g.ChanneltoRepeater,ChannelBuffertoRepeaterBuffer). See #18 for the rationale behind this name change.
- Renamed all instances of
ChanneltoRepeater(e.g.ChanneltoRepeater,ChannelBuffertoRepeaterBuffer). See #18 for the rationale behind this name change.
- Fixed timers using the wrong version of @channel/channel.
- Fixed limiters using the wrong version of @channel/channel.
- Fixed pubsub using the wrong version of @channel/channel.
- The
Channelclass now exposes the static methodsChannel.race,Channel.merge,Channel.zipandChannel.latest#4.
- The
closeandstoparguments passed to executor have been merged as the second argument. - The
stoppromise resolves to argument passed toreturnifreturnis called. - The
pushfunction now resolves to the value passed to next. - The
pushfunction now unwraps promise-like values passed to push. - Buffers now throw an error if
removeis called when the buffer is empty. - Channel properties and methods which don’t belong to the async iterator interface are now hidden using a private WeakMap.
- Channels stop immediately when the executor throws an error.
- Executor now runs synchronously when
nextis called for the first time (#10). - The final iteration result/errors are now consumed by iterator methods.
return/throwbehave more like the methods do forasync generators.
delaynow returns an channel which can be reusedtimeoutreturns a channel
- throttler can now be passed a
cooldownboolean option which forces the channel to wait before yielding the final token.
- semaphore and throttler now both return channels rather than async iterators.
- throttler function now takes options instead of a number representing limit as the second arg.
- semaphore and throttler will throw a RangeError if limit is less than 1.
- throttler now uses a sliding window to limit #1.
- Type definitions have changed slightly.
- Adds throw method to channels.
- Initial release.
- Initial release.
- Initial release.
- Initial release.