WritableStream

这是 实验性技术
检查 浏览器兼容性表格 在生产中使用这之前。

WritableStream interface of the the Streams API provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in backpressure and queuing.

构造函数

WritableStream()
创建新的 WritableStream 对象。

特性

WritableStream.locked 只读
A boolean indicating whether the WritableStream is locked to a writer.

方法

WritableStream.abort()
Aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.
WritableStream.close()
Closes the stream.
WritableStream.getWriter()
Returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance. While the stream is locked, no other writer can be acquired until this one is released.

范例

The following example illustrates several features of this interface.  It shows the creation of the WritableStream with a custom sink and an API-supplied queueing strategy. It then calls a function called sendMessage() , passing the newly created stream and a string. Inside this function it calls the stream's getWriter() method, which returns an instance of WritableStreamDefaultWriter . A forEach() call is used to write each chunk of the string to the stream. Finally, write() and close() return promises that are processed to deal with success or failure of chunks and streams.

    const list = document.querySelector('ul');
    function sendMessage(message, writableStream) {
      // defaultWriter is of type 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);
          });
      });
      // Call ready again to ensure that all chunks are written
      //   before closing the writer.
      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({
      // Implement the sink
      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);
    					

    You can find the full code in our Simple writer example .

    Backpressure

    Because of how backpressure is supported in the API, its implementation in code may be less than obvious. To see how backpressure is implemented look for three things.

    • highWaterMark property, which is set when creating the counting strategy (line 35), sets the maximum amount of data that the WritableStream instance will handle in a single write() operation. In this example, it's the maximum amount of data that can be sent to defaultWriter.write() (line 11).
    • defaultWriter.ready property returns a promise that resolves when the sink (the first property of the WritableStream constructor) is done writing data. The data source can either write more data (line 9) or call close() (line 24). Calling close() too early can prevent data from being written. This is why the example calls defaultWriter.ready twice (lines 9 and 22).
    • Promise returned by the sink's write() method (line 40) tells the WritableStream and its writer when to resolve defaultWriter.ready .

    规范

    规范 状态 Comment

    The definition of 'WritableStream' in that specification.
    实时标准 初始定义。

    浏览器兼容性

    更新 GitHub 上的兼容性数据
    Desktop Mobile
    Chrome Edge Firefox Internet Explorer Opera Safari Android webview Chrome for Android Firefox for Android Opera for Android Safari on iOS Samsung Internet
    WritableStream
    Chrome 59 Edge 16 Firefox 不支持 No IE 不支持 No Opera 47 Safari ? WebView Android 59 Chrome Android 59 Firefox Android 不支持 No Opera Android 44 Safari iOS ? Samsung Internet Android 7.0
    WritableStream() 构造函数
    Chrome 59 Edge 16 Firefox 不支持 No IE 不支持 No Opera 47 Safari ? WebView Android 59 Chrome Android 59 Firefox Android 不支持 No Opera Android 44 Safari iOS ? Samsung Internet Android 7.0
    abort
    Chrome 59 Edge 16 Firefox 不支持 No IE 不支持 No Opera 47 Safari ? WebView Android 59 Chrome Android 59 Firefox Android 不支持 No Opera Android 44 Safari iOS ? Samsung Internet Android 7.0
    getWriter
    Chrome 59 Edge 16 Firefox 不支持 No IE 不支持 No Opera 47 Safari ? WebView Android 59 Chrome Android 59 Firefox Android 不支持 No Opera Android 44 Safari iOS ? Samsung Internet Android 7.0
    locked
    Chrome 59 Edge 16 Firefox 不支持 No IE 不支持 No Opera 47 Safari ? WebView Android 59 Chrome Android 59 Firefox Android 不支持 No Opera Android 44 Safari iOS ? Samsung Internet Android 7.0

    图例

    完整支持
    完整支持
    不支持
    不支持
    兼容性未知
    兼容性未知
    实验。期望将来行为有所改变。
    实验。期望将来行为有所改变。

    另请参阅