WritableStreamDefaultWriter: close() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since May 2022.

Note: This feature is available in Web Workers.

close() của giao diện WritableStreamDefaultWriter đóng luồng ghi liên kết.

Sink nền tảng sẽ hoàn tất việc xử lý mọi khối đã được ghi trước đó, trước khi gọi hành vi đóng. Trong thời gian này, mọi nỗ lực ghi thêm sẽ thất bại, nhưng không làm luồng chuyển sang trạng thái lỗi.

Cú pháp

close()

Giá trị trả về

Một Promise, được hoàn tất với undefined nếu tất cả các khối còn lại đã được ghi thành công trước khi đóng, hoặc bị từ chối với lỗi nếu xảy ra sự cố trong quá trình này.

Ngoại lệ

TypeError: Luồng bạn đang cố đóng không phải là một WritableStream.

Ví dụ sau cho thấy việc tạo một WritableStream với một sink tùy chỉnh và một chiến lược xếp hàng do API cung cấp. Sau đó nó gọi một hàm tên là sendMessage(), truyền vào luồng mới được tạo và một chuỗi. Bên trong hàm này, nó gọi phương thức getWriter() của luồng, phương thức này trả về một thể hiện của WritableStreamDefaultWriter. Mỗi khối của chuỗi đã mã hóa được ghi vào luồng bằng phương thức write(), và phương thức forEach() của Uint8Array đã mã hóa được dùng để xử lý từng byte. Cuối cùng, close() được gọi và promise mà nó trả về được xử lý để giải quyết thành công hoặc mọi lỗi của các thao tác ghi theo khối.

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);
  encoded.forEach((chunk) => {
    defaultWriter.ready
      .then(() => {
        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) => {
        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);

Bạn có thể xem một bản trình diễn trực tiếp của ví dụ này tại ví dụ trình ghi đơn giản của chúng tôi.