TransformStreamDefaultController: enqueue() method

{{APIRef("Streams")}}{{AvailableInWorkers}}

The enqueue() method of the {{domxref("TransformStreamDefaultController")}} interface enqueues the given chunk in the readable side of the stream.

For more information on readable streams and chunks see Using Readable Streams.

Syntax

enqueue(chunk)

Parameters

• chunk
  • : The chunk being queued. A chunk is a single piece of data. It can be any type of data, and a stream can contain chunks of different types.

Return value

None ({{jsxref("undefined")}}).

Exceptions

• {{jsxref("TypeError")}}
  • : The stream is not readable. This might occur if the stream is errored via controller.error(), or when it is closed without its controller's controller.close() method ever being called.

Examples

In this example an encoded chunk is passed to the queue using the enqueue() method.

const textEncoderStream = new TransformStream({
  transform(chunk, controller) {
    controller.enqueue(new TextEncoder().encode(chunk));
  },
  flush(controller) {
    controller.terminate();
  },
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}