Skip to content

Commit da4134b

Browse files
committed
chore: document parameters and ordering #65 (comment)
1 parent aa1c757 commit da4134b

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

asynciterator.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1632,9 +1632,11 @@ export class UnionIterator<T> extends AsyncIterator<T> {
16321632

16331633
/**
16341634
Creates a new `UnionIterator`.
1635-
@param {module:asynciterator.AsyncIterator|Array} [sources] The sources to read from
1635+
@param {module:asynciterator.AsyncIterator|Array} [sources] The sources to read from.
16361636
@param {object} [options] Settings of the iterator
16371637
@param {boolean} [options.destroySource=true] Whether the sources should be destroyed when transformed iterator is closed or destroyed
1638+
@param {number} [options.maxParallelIterators=Infinity] The maximum number of iterators that can be read from simultaneously.
1639+
Setting equal to 1 will cause iterators to be read from sequentially and in order.
16381640
*/
16391641
constructor(sources: AsyncIteratorOrArray<AsyncIterator<T>> |
16401642
AsyncIteratorOrArray<Promise<AsyncIterator<T>>> |

0 commit comments

Comments
 (0)