Interface: StdioInputStream
Extends
ReadableStream<Uint8Array>
Properties
isTerminal
isTerminal:
boolean
locked
readonlylocked:boolean
The locked read-only property of the ReadableStream interface returns whether or not the readable stream is locked to a reader.
Inherited from
type
type:
StdioType
Methods
[asyncIterator]()
[asyncIterator](
options?):ReadableStreamAsyncIterator<Uint8Array<ArrayBufferLike>>
Parameters
options?
ReadableStreamIteratorOptions
Returns
ReadableStreamAsyncIterator<Uint8Array<ArrayBufferLike>>
Inherited from
ReadableStream.[asyncIterator]
cancel()
cancel(
reason?):Promise<void>
The cancel() method of the ReadableStream interface returns a Promise that resolves when the stream is canceled.
Parameters
reason?
any
Returns
Promise<void>
Inherited from
ReadableStream.cancel
getReader()
Call Signature
getReader(
options):ReadableStreamBYOBReader
The getReader() method of the ReadableStream interface creates a reader and locks the stream to it. While the stream is locked, no other reader can be acquired until this one is released.
Parameters
options
mode
"byob"
Returns
ReadableStreamBYOBReader
Inherited from
ReadableStream.getReader
Call Signature
getReader():
ReadableStreamDefaultReader<Uint8Array<ArrayBufferLike>>
Returns
ReadableStreamDefaultReader<Uint8Array<ArrayBufferLike>>
Inherited from
ReadableStream.getReader
Call Signature
getReader(
options?):ReadableStreamReader<Uint8Array<ArrayBufferLike>>
Parameters
options?
ReadableStreamGetReaderOptions
Returns
ReadableStreamReader<Uint8Array<ArrayBufferLike>>
Inherited from
ReadableStream.getReader
pipeThrough()
pipeThrough<
T>(transform,options?):ReadableStream<T>
The pipeThrough() method of the ReadableStream interface provides a chainable way of piping the current stream through a transform stream or any other writable/readable pair.
Type Parameters
T
T
Parameters
transform
ReadableWritablePair<T, Uint8Array<ArrayBufferLike>>
options?
StreamPipeOptions
Returns
ReadableStream<T>
Inherited from
ReadableStream.pipeThrough
pipeTo()
pipeTo(
destination,options?):Promise<void>
The pipeTo() method of the ReadableStream interface pipes the current ReadableStream to a given WritableStream and returns a Promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.
Parameters
destination
WritableStream<Uint8Array<ArrayBufferLike>>
options?
StreamPipeOptions
Returns
Promise<void>
Inherited from
ReadableStream.pipeTo
setRawMode()
setRawMode(
enable):void
Parameters
enable
boolean
Returns
void
tee()
tee(): [
ReadableStream<Uint8Array<ArrayBufferLike>>,ReadableStream<Uint8Array<ArrayBufferLike>>]
The tee() method of the ReadableStream interface tees the current readable stream, returning a two-element array containing the two resulting branches as new ReadableStream instances.
Returns
[ReadableStream<Uint8Array<ArrayBufferLike>>, ReadableStream<Uint8Array<ArrayBufferLike>>]
Inherited from
ReadableStream.tee
values()
values(
options?):ReadableStreamAsyncIterator<Uint8Array<ArrayBufferLike>>
Parameters
options?
ReadableStreamIteratorOptions
Returns
ReadableStreamAsyncIterator<Uint8Array<ArrayBufferLike>>
Inherited from
ReadableStream.values