Fix types

MattiasBuelens · Feb 24, 2020 · 759506e · 759506e
1 parent 0662010
commit 759506e
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 14 deletions.
diff --git a/etc/web-streams-polyfill.api.md b/etc/web-streams-polyfill.api.md
@@ -128,12 +128,13 @@ export type ReadableStreamDefaultController<R> = ReadableStreamDefaultController
 export type ReadableStreamDefaultReader<R> = ReadableStreamDefaultReader_2<R>;
 
 // @public (undocumented)
-export interface ReadResult<T = any> {
-    // (undocumented)
-    done: boolean;
-    // (undocumented)
+export type ReadResult<T> = {
+    done: false;
     value: T;
-}
+} | {
+    done: true;
+    value?: T;
+};
 
 // @public (undocumented)
 export interface Transformer<I = any, O = any> {

diff --git a/src/lib/readable-stream/async-iterator.ts b/src/lib/readable-stream/async-iterator.ts
@@ -10,7 +10,8 @@ import {
   ReadableStreamCreateReadResult,
   ReadableStreamReaderGenericCancel,
   ReadableStreamReaderGenericRelease,
-  readerLockException
+  readerLockException,
+  ReadResult
 } from './generic-reader';
 import assert from '../../stub/assert';
 import { promiseRejectedWith, promiseResolvedWith, transformPromiseWith, typeIsObject } from '../helpers';
@@ -34,7 +35,7 @@ declare class ReadableStreamAsyncIteratorImpl<R> implements ReadableStreamAsyncI
 }
 
 const ReadableStreamAsyncIteratorPrototype: ReadableStreamAsyncIteratorImpl<any> = {
-  next(): Promise<IteratorResult<any>> {
+  next(this: ReadableStreamAsyncIteratorImpl<any>): Promise<ReadResult<any>> {
     if (IsReadableStreamAsyncIterator(this) === false) {
       return promiseRejectedWith(streamAsyncIteratorBrandCheckException('next'));
     }
@@ -54,7 +55,7 @@ const ReadableStreamAsyncIteratorPrototype: ReadableStreamAsyncIteratorImpl<any>
     });
   },
 
-  return(value: any): Promise<IteratorResult<any>> {
+  return(this: ReadableStreamAsyncIteratorImpl<any>, value: any): Promise<ReadResult<any>> {
     if (IsReadableStreamAsyncIterator(this) === false) {
       return promiseRejectedWith(streamAsyncIteratorBrandCheckException('next'));
     }

diff --git a/src/lib/readable-stream/generic-reader.ts b/src/lib/readable-stream/generic-reader.ts
@@ -2,10 +2,12 @@ import assert from '../../stub/assert';
 import { ReadableStream, ReadableStreamCancel, ReadableStreamReader } from '../readable-stream';
 import { newPromise, setPromiseIsHandledToTrue } from '../helpers';
 
-// TODO Fix ReadableStreamReadResult<R> in TypeScript DOM types
-export interface ReadResult<T = any> {
-  done: boolean;
+export type ReadResult<T> = {
+  done: false;
   value: T;
+} | {
+  done: true;
+  value?: T;
 }
 
 export function ReadableStreamCreateReadResult<T>(value: T | undefined,

diff --git a/src/lib/readable-stream/pipe.ts b/src/lib/readable-stream/pipe.ts
@@ -109,12 +109,12 @@ export function ReadableStreamPipeTo<T>(source: ReadableStream<T>,
       }
 
       return PerformPromiseThen(writer._readyPromise, () => {
-        return PerformPromiseThen(ReadableStreamDefaultReaderRead(reader), ({ value, done }) => {
-          if (done === true) {
+        return PerformPromiseThen(ReadableStreamDefaultReaderRead(reader), result => {
+          if (result.done === true) {
             return true;
           }
 
-          currentWrite = PerformPromiseThen(WritableStreamDefaultWriterWrite(writer, value), undefined, noop);
+          currentWrite = PerformPromiseThen(WritableStreamDefaultWriterWrite(writer, result.value), undefined, noop);
           return false;
         });
       });