WritableStreamDefaultWriter

Experimental

これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

Streams APIWritableStreamDefaultWriter インターフェイスは、WritableStream.getWriter() によって返されるオブジェクトであり、作成されるとライターを WritableStream にロックし、他のストリームが基になるシンクに書き込めないようにします。

コンストラクター

WritableStreamDefaultWriter()
新しい WritableStreamDefaultWriter オブジェクトのインスタンスを作成します。

プロパティ

WritableStreamDefaultWriter.closed読取専用
ストリーミングプロセスの終了に応答するコードを記述できます。 ストリームが閉じられるか、ライターのロックが解除されると満たされる promise を返します。 ストリームがエラーになると拒否します。
WritableStreamDefaultWriter.desiredSize読取専用
ストリームの内部キューを満たすために必要な希望サイズを返します。
WritableStreamDefaultWriter.ready読取専用
ストリームの内部キューの希望サイズが非正から正に移行したときに解決する Promise を返し、バックプレッシャーが適用されなくなったことを通知します。

メソッド

WritableStreamDefaultWriter.abort()
ストリームを中止し、プロデューサーがストリームに正常に書き込むことができなくなり、キューに入れられた書き込みを破棄してすぐにエラー状態に移行することを通知します。
WritableStreamDefaultWriter.close()
関連する書き込み可能なストリームを閉じます。
WritableStreamDefaultWriter.releaseLock()
対応するストリームのライターのロックを解除します。 ロックを解除すると、ライターはアクティブではなくなります。 ロックを解除したときに関連するストリームにエラーが発生した場合、ライターはこれ以降同じようにエラーが発生したように見えます。 そうでない場合、ライターは閉じられたように見えます。
WritableStreamDefaultWriter.write()
渡されたデータのチャンクを WritableStream とその基になるシンクに書き込んでから、書き込み操作の成功または失敗を示すために解決する Promise を返します。

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

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(() => {
        return 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) => {
      var buffer = new ArrayBuffer(2);
      var view = new Uint16Array(buffer);
      view[0] = chunk;
      var decoded = decoder.decode(view, { stream: true });
      var listItem = document.createElement('li');
      listItem.textContent = "Chunk decoded: " + decoded;
      list.appendChild(listItem);
      result += decoded;
      resolve();
    });
  },
  close() {
    var listItem = document.createElement('li');
    listItem.textContent = "[MESSAGE RECEIVED] " + result;
    list.appendChild(listItem);
  },
  abort(err) {
    console.log("Sink error:", err);
  }
}, queuingStrategy);

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

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

仕様

仕様 状態 コメント
Streams
WritableStreamDefaultWriter の定義
現行の標準 初期定義

ブラウザーの互換性

BCD tables only load in the browser