Cloudflare Docs
Workers
Cloudflare Docs
Workers
Search icon (depiction of a magnifying glass)
GitHub icon
Visit Workers on GitHub
Set theme to dark (⇧+D)

WritableStreamDefaultWriter

Background

A writer is used when you want to write directly to a WritableStream , rather than piping data to it from a ReadableStream . For example:

function writeArrayToStream(array, writableStream) {
  const writer = writableStream.getWriter();
  array.forEach(chunk => writer.write(chunk).catch(() => {}));

  return writer.close();
}

writeArrayToStream([1, 2, 3, 4, 5], writableStream)
  .then(() => console.log('All done!'))
  .catch(e => console.error('Error with the stream: ' + e));

Properties

  • desiredSize int

    • The size needed to fill the stream’s internal queue, as an integer. Always returns 1, 0 (if the stream is closed), or null (if the stream has errors).

  • closed Promise<void>

    • A promise that indicates if the writer is closed. The promise is fulfilled when the writer stream is closed and rejected if there is an error in the stream.

Methods

  • abort(reasonstringoptional) Promise<void>

    *   Aborts the stream. This method returns a promise that fulfills with a response `undefined`. `reason` is an optional human-readable string indicating the reason for cancellation. `reason` will be passed to the underlying sink’s abort algorithm. If this writable stream is one side of a [TransformStream](/workers/runtime-apis/streams/transformstream/), then its abort algorithm causes the transform’s readable side to become errored with `reason`.

  <aside class="DocsMarkdown--aside" role="note" data-type="warning">
    Warning
    Any data not yet written is lost upon abort.

  • close() Promise<void>

    • Attempts to close the writer. Remaining writes finish processing before the writer is closed. This method returns a promise fulfilled with undefined if the writer successfully closes and processes the remaining writes, or rejected on any error.

  • releaseLock() void

    • Releases the writer’s lock on the stream. Once released, the writer is no longer active. You can call this method before all pending write(chunk) calls are resolved. This allows you to queue a write operation, release the lock, and begin piping into the writable stream from another source, as shown in the example below.

      let writer = writable.getWriter();
// Write a preamble.
writer.write(new TextEncoder().encode('foo bar'));
// While that’s still writing, pipe the rest of the body from somewhere else.
writer.releaseLock();
await someResponse.body.pipeTo(writable);

  • write(chunkany) Promise<void>

    • Writes a chunk of data to the writer and returns a promise that resolves if the operation succeeds.