Skip to main content

Interface: StdioOutputStream

Extends​

  • WritableStream<Uint8Array>

Properties​

height​

height: number

isTerminal​

isTerminal: boolean

locked​

readonly locked: boolean

The locked read-only property of the WritableStream interface returns a boolean indicating whether the WritableStream is locked to a writer.

MDN Reference

Inherited from​

WritableStream.locked

type​

type: StdioType

width​

width: number

Methods​

abort()​

abort(reason?): Promise<void>

The abort() method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.

MDN Reference

Parameters​

reason?​

any

Returns​

Promise<void>

Inherited from​

WritableStream.abort

close()​

close(): Promise<void>

The close() method of the WritableStream interface closes the associated stream. All chunks written before this method is called are sent before the returned promise is fulfilled.

MDN Reference

Returns​

Promise<void>

Inherited from​

WritableStream.close

getWriter()​

getWriter(): WritableStreamDefaultWriter<Uint8Array<ArrayBufferLike>>

The getWriter() method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance. While the stream is locked, no other writer can be acquired until this one is released.

MDN Reference

Returns​

WritableStreamDefaultWriter<Uint8Array<ArrayBufferLike>>

Inherited from​

WritableStream.getWriter