web-streams-polyfill 3.3.1 → 3.3.3

package/dist/types/polyfill.d.ts

@@ -0,0 +1,24 @@
+/// <reference lib="dom" />
+/// <reference lib="esnext.asynciterable" />
+import { ReadableStreamAsyncIterator, ReadableStreamIteratorOptions } from './ponyfill';
+export * from './ponyfill';
+declare global {
+    interface ReadableStream<R = any> extends AsyncIterable<R> {
+        /**
+         * Asynchronously iterates over the chunks in the stream's internal queue.
+         *
+         * Asynchronously iterating over the stream will lock it, preventing any other consumer from acquiring a reader.
+         * The lock will be released if the async iterator's {@link ReadableStreamAsyncIterator.return | return()} method
+         * is called, e.g. by breaking out of the loop.
+         *
+         * By default, calling the async iterator's {@link ReadableStreamAsyncIterator.return | return()} method will also
+         * cancel the stream. To prevent this, use the stream's {@link ReadableStream.values | values()} method, passing
+         * `true` for the `preventCancel` option.
+         */
+        values(options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIterator<R>;
+        /**
+         * {@inheritDoc ReadableStream.values}
+         */
+        [Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIterator<R>;
+    }
+}

package/dist/types/ponyfill.d.ts

@@ -126,7 +126,7 @@ export declare class ReadableByteStreamController {
  *
  * @public
  */
-export declare class ReadableStream<R = any> {
+export declare class ReadableStream<R = any> implements AsyncIterable<R> {
     constructor(underlyingSource: UnderlyingByteSource, strategy?: {
         highWaterMark?: number;
         size?: undefined;
@@ -213,7 +213,7 @@ export declare class ReadableStream<R = any> {
     /**
      * {@inheritDoc ReadableStream.values}
      */
-    [Symbol.asyncIterator]: (options?: ReadableStreamIteratorOptions) => ReadableStreamAsyncIterator<R>;
+    [Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIterator<R>;
     /**
      * Creates a new ReadableStream wrapping the provided iterable or async iterable.
      *
@@ -227,7 +227,7 @@ export declare class ReadableStream<R = any> {
  *
  * @public
  */
-export declare interface ReadableStreamAsyncIterator<R> extends AsyncIterator<R> {
+export declare interface ReadableStreamAsyncIterator<R> extends AsyncIterableIterator<R> {
     next(): Promise<IteratorResult<R>>;
     return(value?: any): Promise<IteratorResult<any>>;
 }

package/dist/types/ts3.6/polyfill.d.ts

@@ -0,0 +1,28 @@
+/// <reference lib="dom" />
+/// <reference lib="es2018.asynciterable" />
+
+import type { ReadableStreamAsyncIterator, ReadableStreamIteratorOptions } from './ponyfill';
+
+export * from './ponyfill';
+
+declare global {
+  interface ReadableStream<R = any> extends AsyncIterable<R> {
+    /**
+     * Asynchronously iterates over the chunks in the stream's internal queue.
+     *
+     * Asynchronously iterating over the stream will lock it, preventing any other consumer from acquiring a reader.
+     * The lock will be released if the async iterator's {@link ReadableStreamAsyncIterator.return | return()} method
+     * is called, e.g. by breaking out of the loop.
+     *
+     * By default, calling the async iterator's {@link ReadableStreamAsyncIterator.return | return()} method will also
+     * cancel the stream. To prevent this, use the stream's {@link ReadableStream.values | values()} method, passing
+     * `true` for the `preventCancel` option.
+     */
+    values(options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIterator<R>;
+
+    /**
+     * {@inheritDoc ReadableStream.values}
+     */
+    [Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIterator<R>;
+  }
+}

package/dist/types/ts3.6/ponyfill.d.ts

@@ -134,7 +134,7 @@ export declare class ReadableByteStreamController {
  *
  * @public
  */
-export declare class ReadableStream<R = any> {
+export declare class ReadableStream<R = any> implements AsyncIterable<R> {
     constructor(underlyingSource: UnderlyingByteSource, strategy?: {
         highWaterMark?: number;
         size?: undefined;
@@ -218,7 +218,7 @@ export declare class ReadableStream<R = any> {
     /**
      * {@inheritDoc ReadableStream.values}
      */
-    [Symbol.asyncIterator]: (options?: ReadableStreamIteratorOptions) => ReadableStreamAsyncIterator<R>;
+    [Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIterator<R>;
     /**
      * Creates a new ReadableStream wrapping the provided iterable or async iterable.
      *
@@ -233,7 +233,7 @@ export declare class ReadableStream<R = any> {
  *
  * @public
  */
-export declare interface ReadableStreamAsyncIterator<R> extends AsyncIterator<R> {
+export declare interface ReadableStreamAsyncIterator<R> extends AsyncIterableIterator<R> {
     next(): Promise<IteratorResult<R, undefined>>;
     return(value?: any): Promise<IteratorResult<any>>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "web-streams-polyfill",
-  "version": "3.3.1",
+  "version": "3.3.3",
   "description": "Web Streams, based on the WHATWG spec reference implementation",
   "main": "dist/polyfill",
   "browser": "dist/polyfill.min.js",