class WritableStream
Supported only in the v8 engine. Introduced in Max v9.2.0.
A byte-oriented writable stream companion for piping.
Index
Constructors
Methods
new WritableStream(underlyingSink, strategy)
new WritableStream(underlyingSink?: any, strategy?: any);
Constructs a new instance of the WritableStream class
| Parameter | Type | Description |
|---|---|---|
| optional underlyingSink | any | an object with optional start, write, close, and abort methods. |
| optional strategy | any | an optional queuing strategy. |
abort(reason)
Aborts the stream.
abort(reason?: any): Promise<void>;
| Name | Type | Description |
|---|---|---|
| optional reason | any | |
| Return Value | Promise<void> |
close()
Closes the stream.
close(): Promise<void>;
| Name | Type | Description |
|---|---|---|
| Return Value | Promise<void> |
getWriter()
Acquires a writer and locks the stream.
getWriter(): WritableStreamDefaultWriter;
| Name | Type | Description |
|---|---|---|
| Return Value | WritableStreamDefaultWriter |