WritableStream

WritableStreamストリーム API のインターフェイスで、ストリーミングデータをシンクと呼ばれる宛先に書き込むための標準的な抽象化を提供します。 このオブジェクトには、背圧とキューイングが組み込まれています。

WritableStream移譲可能オブジェクトです。

コンストラクター

WritableStream()

新しい WritableStream オブジェクトを作成します。

プロパティ

WritableStream.locked 読取専用

論理値で、 WritableStream がライターにロックされているかどうかを示します。

メソッド

WritableStream.abort()

ストリームを中止し、プロデューサーがストリームに正常に書き込むことができなくなり、キューに入れられた書き込みが破棄されてすぐにエラー状態に移行することを通知します。

WritableStream.close()

ストリームを閉じます。

WritableStream.getWriter()

WritableStreamDefaultWriter の新しいインスタンスを返し、そのインスタンスにストリームをロックします。 ストリームがロックされている間、このライターが開放されるまで他のライターを取得することはできません。

次の例は、このインターフェイスのいくつかの機能を示しています。 カスタムのシンクと API 提供のキューイング戦略を使用した WritableStream の作成を示しています。 次に、sendMessage() という関数を呼び出し、新しく作成したストリームと文字列を渡します。 この関数内で、WritableStreamDefaultWriter のインスタンスを返すストリームの getWriter() メソッドを呼び出します。 forEach() 呼び出しを使用して、文字列の各チャンクをストリームに書き込みます。 最後に、write() および close() は、チャンクとストリームの成功または失敗に対処するためのプロミスを返します。

const list = document.querySelector('ul');

function sendMessage(message, writableStream) {
  // defaultWriter は WritableStreamDefaultWriter 型です
  const defaultWriter = writableStream.getWriter();
  const encoder = new TextEncoder();
  const encoded = encoder.encode(message, { stream: true });
  encoded.forEach((chunk) => {
    defaultWriter.ready
      .then(() => defaultWriter.write(chunk))
      .then(() => {
        console.log("Chunk written to sink.");
      })
      .catch((err) => {
        console.log("Chunk error:", err);
      });
  });
  // ライターを閉じる前にすべてのチャンクが
  // 確実に書き込まれるように、ready を再度呼び出します。
  defaultWriter.ready
    .then(() => {
      defaultWriter.close();
    })
    .then(() => {
      console.log("All chunks written");
    })
    .catch((err) => {
      console.log("Stream error:", err);
    });
}

const decoder = new TextDecoder("utf-8");
const queuingStrategy = new CountQueuingStrategy({ highWaterMark: 1 });
let result = "";
const writableStream = new WritableStream({
  // シンクの実装
  write(chunk) {
    return new Promise((resolve, reject) => {
      const buffer = new ArrayBuffer(1);
      const view = new Uint8Array(buffer);
      view[0] = chunk;
      const decoded = decoder.decode(view, { stream: true });
      const listItem = document.createElement('li');
      listItem.textContent = `Chunk decoded: ${decoded}`;
      list.appendChild(listItem);
      result += decoded;
      resolve();
    });
  },
  close() {
    const listItem = document.createElement('li');
    listItem.textContent = `[MESSAGE RECEIVED] ${result}`;
    list.appendChild(listItem);
  },
  abort(err) {
    console.log("Sink error:", err);
  }
}, queuingStrategy);

sendMessage("Hello, world.", writableStream);

完全なコードは、単純なライターの例にあります。

背圧

背圧が API でどのように対応しているかによるため、コードでの実装はあまり明白ではないかもしれません。 背圧がどのように実装されているかを確認するためには、次の 3 つのことを確認してください。

  • カウント戦略の作成時に設定される highWaterMark プロパティ(35 行目)は、WritableStream インスタンスが 1 回の write() 操作で処理するデータの最大量を設定します。 この例では、defaultWriter.write() に送信できるデータの最大量です(11 行目)。
  • defaultWriter.ready プロパティは、シンク(WritableStream コンストラクターの最初のプロパティ)がデータの書き込みを完了すると解決するプロミスを返します。 データソースは、さらにデータを書き込む(11 行目)か、 close() (24 行目)を呼び出すことができます。 close() の呼び出しが早すぎると、データの書き込みが妨げられる可能性があります。 このため、この例では defaultWriter.ready を 2 回呼び出しています(9 行目と 22 行目)。
  • シンクの write() メソッドによって返される Promise(40 行目)は、WritableStream とそのライターに、いつ defaultWriter.ready を解決するかを伝えます。

仕様書

Specification
Streams Standard
# ws-class

ブラウザーの互換性

BCD tables only load in the browser

関連情報

  • WHATWG Stream Visualiser: 読み取り可能なストリーム、書き込み可能なストリーム、および変換ストリームの基本的な視覚化。