web-streams-polyfill 3.0.2 → 3.2.0

package/dist/types/polyfill.d.ts

@@ -89,7 +89,9 @@ export declare interface QueuingStrategyInit {
 
 declare type QueuingStrategySizeCallback<T = any> = (chunk: T) => number;
 
-declare type ReadableByteStream = ReadableStream<Uint8Array>;
+declare type ReadableByteStream = ReadableStream<Uint8Array> & {
+    _readableStreamController: ReadableByteStreamController;
+};
 
 /**
  * Allows control of a {@link ReadableStream | readable byte stream}'s state and internal queue.
@@ -173,7 +175,10 @@ export declare class ReadableStream<R = any> {
      *
      * Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader.
      */
-    pipeThrough<T>(transform: ReadableWritablePair<T, R>, options?: StreamPipeOptions): ReadableStream<T>;
+    pipeThrough<RS extends ReadableStream>(transform: {
+        readable: RS;
+        writable: WritableStream<R>;
+    }, options?: StreamPipeOptions): RS;
     /**
      * Pipes this readable stream to a given writable stream. The way in which the piping process behaves under
      * various error conditions can be customized with a number of passed options. It returns a promise that fulfills
@@ -218,7 +223,7 @@ export declare class ReadableStream<R = any> {
  * @public
  */
 export declare interface ReadableStreamAsyncIterator<R> extends AsyncIterator<R> {
-    next(): Promise<IteratorResult<R>>;
+    next(): Promise<IteratorResult<R, undefined>>;
     return(value?: any): Promise<IteratorResult<any>>;
 }
 
@@ -233,7 +238,7 @@ export declare class ReadableStreamBYOBReader {
      * Returns a promise that will be fulfilled when the stream becomes closed, or rejected if the stream ever errors or
      * the reader's lock is released before the stream finishes closing.
      */
-    readonly closed: Promise<void>;
+    readonly closed: Promise<undefined>;
     /**
      * If the reader is active, behaves the same as {@link ReadableStream.cancel | stream.cancel(reason)}.
      */
@@ -262,8 +267,11 @@ export declare class ReadableStreamBYOBReader {
  * @public
  */
 export declare type ReadableStreamBYOBReadResult<T extends ArrayBufferView> = {
-    done: boolean;
+    done: false;
     value: T;
+} | {
+    done: true;
+    value: T | undefined;
 };
 
 /**
@@ -333,7 +341,7 @@ export declare class ReadableStreamDefaultReader<R = any> {
      * Returns a promise that will be fulfilled when the stream becomes closed,
      * or rejected if the stream ever errors or the reader's lock is released before the stream finishes closing.
      */
-    readonly closed: Promise<void>;
+    readonly closed: Promise<undefined>;
     /**
      * If the reader is active, behaves the same as {@link ReadableStream.cancel | stream.cancel(reason)}.
      */
@@ -366,7 +374,7 @@ export declare type ReadableStreamDefaultReadResult<T> = {
     value: T;
 } | {
     done: true;
-    value: undefined;
+    value?: undefined;
 };
 
 /**
@@ -658,7 +666,7 @@ export declare class WritableStream<W = any> {
      * successfully closes, or rejects if an error is encountered during this process. Additionally, it will reject with
      * a `TypeError` (without attempting to cancel the stream) if the stream is currently locked.
      */
-    close(): Promise<void>;
+    close(): Promise<undefined>;
     /**
      * Creates a {@link WritableStreamDefaultWriter | writer} and locks the stream to the new writer. While the stream
      * is locked, no other writer can be acquired until this one is released.
@@ -677,6 +685,18 @@ export declare class WritableStream<W = any> {
  */
 export declare class WritableStreamDefaultController<W = any> {
     private constructor();
+    /**
+     * The reason which was passed to `WritableStream.abort(reason)` when the stream was aborted.
+     *
+     * @deprecated
+     *  This property has been removed from the specification, see https://github.com/whatwg/streams/pull/1177.
+     *  Use {@link WritableStreamDefaultController.signal}'s `reason` instead.
+     */
+    readonly abortReason: any;
+    /**
+     * An `AbortSignal` that can be used to abort the pending write or close operation when the stream is aborted.
+     */
+    readonly signal: AbortSignal;
     /**
      * Closes the controlled writable stream, making all future interactions with it fail with the given error `e`.
      *
@@ -698,7 +718,7 @@ export declare class WritableStreamDefaultWriter<W = any> {
      * Returns a promise that will be fulfilled when the stream becomes closed, or rejected if the stream ever errors or
      * the writer’s lock is released before the stream finishes closing.
      */
-    readonly closed: Promise<void>;
+    readonly closed: Promise<undefined>;
     /**
      * Returns the desired size to fill the stream’s internal queue. It can be negative, if the queue is over-full.
      * A producer can use this information to determine the right amount of data to write.
@@ -716,7 +736,7 @@ export declare class WritableStreamDefaultWriter<W = any> {
      * If the stream becomes errored or aborted, or the writer’s lock is released, the returned promise will become
      * rejected.
      */
-    readonly ready: Promise<void>;
+    readonly ready: Promise<undefined>;
     /**
      * If the reader is active, behaves the same as {@link WritableStream.abort | stream.abort(reason)}.
      */

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

@@ -89,7 +89,9 @@ export declare interface QueuingStrategyInit {
 
 declare type QueuingStrategySizeCallback<T = any> = (chunk: T) => number;
 
-declare type ReadableByteStream = ReadableStream<Uint8Array>;
+declare type ReadableByteStream = ReadableStream<Uint8Array> & {
+    _readableStreamController: ReadableByteStreamController;
+};
 
 /**
  * Allows control of a {@link ReadableStream | readable byte stream}'s state and internal queue.
@@ -173,7 +175,10 @@ export declare class ReadableStream<R = any> {
      *
      * Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader.
      */
-    pipeThrough<T>(transform: ReadableWritablePair<T, R>, options?: StreamPipeOptions): ReadableStream<T>;
+    pipeThrough<RS extends ReadableStream>(transform: {
+        readable: RS;
+        writable: WritableStream<R>;
+    }, options?: StreamPipeOptions): RS;
     /**
      * Pipes this readable stream to a given writable stream. The way in which the piping process behaves under
      * various error conditions can be customized with a number of passed options. It returns a promise that fulfills
@@ -218,7 +223,7 @@ export declare class ReadableStream<R = any> {
  * @public
  */
 export declare interface ReadableStreamAsyncIterator<R> extends AsyncIterator<R> {
-    next(): Promise<IteratorResult<R>>;
+    next(): Promise<IteratorResult<R, undefined>>;
     return(value?: any): Promise<IteratorResult<any>>;
 }
 
@@ -233,7 +238,7 @@ export declare class ReadableStreamBYOBReader {
      * Returns a promise that will be fulfilled when the stream becomes closed, or rejected if the stream ever errors or
      * the reader's lock is released before the stream finishes closing.
      */
-    get closed(): Promise<void>;
+    get closed(): Promise<undefined>;
     /**
      * If the reader is active, behaves the same as {@link ReadableStream.cancel | stream.cancel(reason)}.
      */
@@ -262,8 +267,11 @@ export declare class ReadableStreamBYOBReader {
  * @public
  */
 export declare type ReadableStreamBYOBReadResult<T extends ArrayBufferView> = {
-    done: boolean;
+    done: false;
     value: T;
+} | {
+    done: true;
+    value: T | undefined;
 };
 
 /**
@@ -333,7 +341,7 @@ export declare class ReadableStreamDefaultReader<R = any> {
      * Returns a promise that will be fulfilled when the stream becomes closed,
      * or rejected if the stream ever errors or the reader's lock is released before the stream finishes closing.
      */
-    get closed(): Promise<void>;
+    get closed(): Promise<undefined>;
     /**
      * If the reader is active, behaves the same as {@link ReadableStream.cancel | stream.cancel(reason)}.
      */
@@ -366,7 +374,7 @@ export declare type ReadableStreamDefaultReadResult<T> = {
     value: T;
 } | {
     done: true;
-    value: undefined;
+    value?: undefined;
 };
 
 /**
@@ -658,7 +666,7 @@ export declare class WritableStream<W = any> {
      * successfully closes, or rejects if an error is encountered during this process. Additionally, it will reject with
      * a `TypeError` (without attempting to cancel the stream) if the stream is currently locked.
      */
-    close(): Promise<void>;
+    close(): Promise<undefined>;
     /**
      * Creates a {@link WritableStreamDefaultWriter | writer} and locks the stream to the new writer. While the stream
      * is locked, no other writer can be acquired until this one is released.
@@ -677,6 +685,18 @@ export declare class WritableStream<W = any> {
  */
 export declare class WritableStreamDefaultController<W = any> {
     private constructor();
+    /**
+     * The reason which was passed to `WritableStream.abort(reason)` when the stream was aborted.
+     *
+     * @deprecated
+     *  This property has been removed from the specification, see https://github.com/whatwg/streams/pull/1177.
+     *  Use {@link WritableStreamDefaultController.signal}'s `reason` instead.
+     */
+    get abortReason(): any;
+    /**
+     * An `AbortSignal` that can be used to abort the pending write or close operation when the stream is aborted.
+     */
+    get signal(): AbortSignal;
     /**
      * Closes the controlled writable stream, making all future interactions with it fail with the given error `e`.
      *
@@ -698,7 +718,7 @@ export declare class WritableStreamDefaultWriter<W = any> {
      * Returns a promise that will be fulfilled when the stream becomes closed, or rejected if the stream ever errors or
      * the writer’s lock is released before the stream finishes closing.
      */
-    get closed(): Promise<void>;
+    get closed(): Promise<undefined>;
     /**
      * Returns the desired size to fill the stream’s internal queue. It can be negative, if the queue is over-full.
      * A producer can use this information to determine the right amount of data to write.
@@ -716,7 +736,7 @@ export declare class WritableStreamDefaultWriter<W = any> {
      * If the stream becomes errored or aborted, or the writer’s lock is released, the returned promise will become
      * rejected.
      */
-    get ready(): Promise<void>;
+    get ready(): Promise<undefined>;
     /**
      * If the reader is active, behaves the same as {@link WritableStream.abort | stream.abort(reason)}.
      */

package/dist/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.9.2"
+      "packageVersion": "7.13.4"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "web-streams-polyfill",
-  "version": "3.0.2",
+  "version": "3.2.0",
   "description": "Web Streams, based on the WHATWG spec reference implementation",
   "main": "dist/polyfill",
   "browser": "dist/polyfill.min.js",
@@ -54,23 +54,23 @@
   },
   "homepage": "https://github.com/MattiasBuelens/web-streams-polyfill#readme",
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.9.2",
+    "@microsoft/api-extractor": "^7.13.4",
     "@rollup/plugin-inject": "^4.0.2",
-    "@rollup/plugin-replace": "^2.3.3",
+    "@rollup/plugin-replace": "^2.4.2",
     "@rollup/plugin-strip": "^2.0.0",
-    "@rollup/plugin-typescript": "^5.0.2",
-    "@types/node": "^12.12.50",
-    "@typescript-eslint/eslint-plugin": "^3.6.1",
-    "@typescript-eslint/parser": "^3.6.1",
-    "@ungap/promise-all-settled": "^1.1.0",
-    "eslint": "^7.5.0",
-    "jasmine": "^3.5.0",
+    "@rollup/plugin-typescript": "^8.2.1",
+    "@types/node": "^14.14.37",
+    "@typescript-eslint/eslint-plugin": "^4.21.0",
+    "@typescript-eslint/parser": "^4.21.0",
+    "@ungap/promise-all-settled": "^1.1.2",
+    "eslint": "^7.23.0",
+    "jasmine": "^3.7.0",
     "micromatch": "^4.0.2",
-    "rollup": "^2.22.1",
-    "rollup-plugin-terser": "^6.1.0",
-    "ts-morph": "^7.1.2",
-    "tslib": "^2.0.0",
-    "typescript": "^3.9.7",
-    "wpt-runner": "^3.2.0"
+    "rollup": "^2.44.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "ts-morph": "^10.0.2",
+    "tslib": "^2.2.0",
+    "typescript": "^4.2.4",
+    "wpt-runner": "^3.2.1"
   }
 }