web-streams-polyfill 4.0.0-beta.3 → 4.1.0

package/types/ponyfill.d.ts

@@ -1,34 +1,22 @@
-/// <reference lib="es2018.asynciterable" />
-
 /**
  * A signal object that allows you to communicate with a request and abort it if required
  * via its associated `AbortController` object.
  *
  * @remarks
- *   This interface is compatible with the `AbortSignal` interface defined in TypeScript's DOM types.
- *   It is redefined here, so it can be polyfilled without a DOM, for example with
- *   {@link https://www.npmjs.com/package/abortcontroller-polyfill | abortcontroller-polyfill} in a Node environment.
+ *   This is equivalent to the `AbortSignal` interface defined in TypeScript's DOM types or `@types/node`.
  *
  * @public
  */
-export declare interface AbortSignal {
-    /**
-     * Whether the request is aborted.
-     */
-    readonly aborted: boolean;
-    /**
-     * The abort reason.
-     */
+export declare type AbortSignal = typeof globalThis extends {
+    AbortSignal: {
+        prototype: infer T;
+    };
+} ? T : {
+    aborted: boolean;
     readonly reason?: any;
-    /**
-     * Add an event listener to be triggered when this signal becomes aborted.
-     */
     addEventListener(type: 'abort', listener: () => void): void;
-    /**
-     * Remove an event listener that was previously added with {@link AbortSignal.addEventListener}.
-     */
     removeEventListener(type: 'abort', listener: () => void): void;
-}
+};
 
 /**
  * A queuing strategy that counts the number of bytes in each chunk.
@@ -134,7 +122,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 +206,14 @@ 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.
+     *
+     * This can be used to adapt various kinds of objects into a readable stream,
+     * such as an array, an async generator, or a Node.js readable stream.
+     */
+    static from<R>(asyncIterable: Iterable<R> | AsyncIterable<R> | ReadableStreamLike<R>): ReadableStream<R>;
 }
 
 /**
@@ -226,7 +221,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>>;
 }
@@ -252,7 +247,7 @@ export declare class ReadableStreamBYOBReader {
      *
      * If reading a chunk causes the queue to become empty, more data will be pulled from the underlying source.
      */
-    read<T extends ArrayBufferView>(view: T): Promise<ReadableStreamBYOBReadResult<T>>;
+    read<T extends ArrayBufferView>(view: T, options?: ReadableStreamBYOBReaderReadOptions): Promise<ReadableStreamBYOBReadResult<T>>;
     /**
      * Releases the reader's lock on the corresponding stream. After the lock is released, the reader is no longer active.
      * If the associated stream is errored when the lock is released, the reader will appear errored in the same way
@@ -265,6 +260,16 @@ export declare class ReadableStreamBYOBReader {
     releaseLock(): void;
 }
 
+/**
+ * Options for {@link ReadableStreamBYOBReader.read | reading} a stream
+ * with a {@link ReadableStreamBYOBReader | BYOB reader}.
+ *
+ * @public
+ */
+export declare interface ReadableStreamBYOBReaderReadOptions {
+    min?: number;
+}
+
 /**
  * A result returned by {@link ReadableStreamBYOBReader.read}.
  *
@@ -368,6 +373,18 @@ export declare class ReadableStreamDefaultReader<R = any> {
     releaseLock(): void;
 }
 
+/**
+ * A common interface for a `ReadableStreamDefaultReader` implementation.
+ *
+ * @public
+ */
+export declare interface ReadableStreamDefaultReaderLike<R = any> {
+    readonly closed: Promise<undefined>;
+    cancel(reason?: any): Promise<void>;
+    read(): Promise<ReadableStreamDefaultReadResult<R>>;
+    releaseLock(): void;
+}
+
 /**
  * A result returned by {@link ReadableStreamDefaultReader.read}.
  *
@@ -390,6 +407,16 @@ export declare interface ReadableStreamIteratorOptions {
     preventCancel?: boolean;
 }
 
+/**
+ * A common interface for a `ReadadableStream` implementation.
+ *
+ * @public
+ */
+export declare interface ReadableStreamLike<R = any> {
+    readonly locked: boolean;
+    getReader(): ReadableStreamDefaultReaderLike<R>;
+}
+
 /**
  * A pair of a {@link ReadableStream | readable stream} and {@link WritableStream | writable stream} that can be passed
  * to {@link ReadableStream.pipeThrough}.
@@ -447,10 +474,17 @@ export declare interface Transformer<I = any, O = any> {
      * through {@link Transformer.transform | transform()}, and the writable side is about to be closed.
      */
     flush?: TransformerFlushCallback<O>;
+    /**
+     * A function called when the readable side is cancelled, or when the writable side is aborted.
+     */
+    cancel?: TransformerCancelCallback;
     readableType?: undefined;
     writableType?: undefined;
 }
 
+/** @public */
+export declare type TransformerCancelCallback = (reason: any) => void | PromiseLike<void>;
+
 /** @public */
 export declare type TransformerFlushCallback<O> = (controller: TransformStreamDefaultController<O>) => void | PromiseLike<void>;
 

package/types/tsdoc-metadata.json

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

package/es5/package.json

@@ -1,6 +0,0 @@
-{
-  "name": "web-streams-polyfill",
-  "main": "../dist/ponyfill.es5.js",
-  "module": "../dist/ponyfill.es5.mjs",
-  "types": "../types/ponyfill.d.ts"
-}

package/polyfill/es5/package.json

@@ -1,5 +0,0 @@
-{
-  "name": "web-streams-polyfill",
-  "main": "../../dist/polyfill.es5.js",
-  "types": "../../types/polyfill.d.ts"
-}

package/polyfill/package.json

@@ -1,5 +0,0 @@
-{
-  "name": "web-streams-polyfill",
-  "main": "../dist/polyfill.js",
-  "types": "../types/polyfill.d.ts"
-}