WritableStreamDefaultWriter.write()
WritableStreamDefaultWriter
接口的 write()
方法将传递的数据块写入 WritableStream
和它的底层接收器,然后返回一个 Promise
,promise 的状态由写入操作是否成功来决定。
请注意,“成功”的含义取决于底层接收器;它可能表示该分块已被接收,但不一定安全地保存到它最终的目的地。
语法
js
write(chunk)
参数
chunk
-
要传递给
WritableStream
的二进制数据块。
返回值
一个 Promise
,成功写入后使用 undefined
兑现,如果在写入过程开始之前写入失败或者流出错,则拒绝。
异常
TypeError
-
目标流不是一个可写流,或者它没有所有者。
示例
下面的例子说明了这个接口的几个功能。它展示了使用自定义接收器和由 API 提供的队列策略创建的 WritableStream
。然后它调用一个 sendMessage()
的函数,传递新创建的流和一个字符串。在这个函数内部,它调用流的 getWriter()
方法,该方法返回一个 WritableStreamDefaultWriter
实例。forEach()
用于将字符串的每个分块写入流。最后,write()
和 close()
方法都会返回 promise,promise 的状态由对应的操作是否成功来决定。
js
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(1);
var view = new Uint8Array(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);
你可以在我们的简单的 writer 示例找到完整代码。
规范
Specification |
---|
Streams Standard # ref-for-default-writer-write①② |
浏览器兼容性
BCD tables only load in the browser