ReadableStream<T>
| Exported By | |
|---|---|
| Extends | |
| All Implemented Interfaces |
|
The implemenation of ReadableStream.
new ReadableStream<T>()
| Parameters | None. |
|---|
Instance Methods
this.addReadRequest() → Promise<IIterableResult<(T|null)>>
Promise<IIterableResult<(T|null)>>| Defined by | ||
|---|---|---|
| Parameters | None. | |
| Returns |
|
this.cancel( reason ) → Promise<undefined>
Promise<undefined>Cancels the ReadableStream with an optional reason. https://streams.spec.whatwg.org/#rs-cancel
| Overrides | |||||
|---|---|---|---|---|---|
| Specified by | |||||
| Parameters |
| ||||
| Returns |
| ||||
this.cancelInternal( reason ) → Promise<undefined>
Promise<undefined>| Overrides | |||||
|---|---|---|---|---|---|
| Parameters |
| ||||
| Returns |
| ||||
this.close() → void
voidNo information.
this.error( e ) → void
void| Defined by | |||||
|---|---|---|---|---|---|
| Parameters |
| ||||
this.fulfillReadRequest( chunk, done ) → void
void| Defined by | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Parameters |
| ||||||||
this.getIterator( options ) → AsyncIterator<(T|null), ?, ?>
AsyncIterator<(T|null), ?, ?>Returns an AyncIterator over the ReadableStream.
If preventCancel is passed as an option, calling the return() method on the iterator will terminate the iterator, but will not cancel the ReadableStream. https://streams.spec.whatwg.org/#rs-get-iterator
| Overrides | |||||
|---|---|---|---|---|---|
| Specified by | |||||
| Parameters |
| ||||
| Returns |
| ||||
this.getNumReadRequests() → number
number| Defined by | ||
|---|---|---|
| Parameters | None. | |
| Returns |
|
this.getReader() → ReadableStreamDefaultReader<(T|null)>
ReadableStreamDefaultReader<(T|null)>Returns a ReadableStreamDefaultReader that enables reading chunks from the source. https://streams.spec.whatwg.org/#rs-get-reader
| Overrides | ||
|---|---|---|
| Specified by | ||
| Parameters | None. | |
| Returns |
|
this.hasDefaultReader() → boolean
boolean| Defined by | ||
|---|---|---|
| Parameters | None. | |
| Returns |
|
this.tee() → Array<ReadableStream>
Array<ReadableStream>Returns an Array with two elements, both new ReadableStreams that contain the same data as this ReadableStream. This stream will become permanently locked. https://streams.spec.whatwg.org/#rs-tee
| Overrides | ||
|---|---|---|
| Specified by | ||
| Parameters | None. | |
| Returns |
|
Instance Properties
this.disturbed → boolean
booleanthis.locked → boolean
booleanReturns true if the ReadableStream has been locked to a reader. https://streams.spec.whatwg.org/#rs-locked
| Overrides | |
|---|---|
| Specified by |
this.readableStreamController → ReadableStreamDefaultController
ReadableStreamDefaultControllerNo information.
this.reader → (ReadableStreamDefaultReader|undefined)
(ReadableStreamDefaultReader|undefined)No information.
this.state → module$exports$goog$streams$liteImpl.ReadableStream.State
module$exports$goog$streams$liteImpl.ReadableStream.StateNo information.
this.storedError → *
*No information.