大网数据广告活动
Web 标准与前端开发

SerialPort: close() method

· 52CE 我爱测

The **`close()`** method of the SerialPort interface returns a Promise that resolves when the port closes.

Web Serial APIwindow_and_dedicated

The close() method of the SerialPort interface returns a Promise that resolves when the port closes.

Syntax

close()

Parameters

None.

Return value

A Promise.

Description

close() closes the serial port if previously-locked SerialPort.readable and SerialPort.writable members are unlocked, meaning the releaseLock() methods have been called for their respective reader and writer.

However, when continuously reading data from a serial device using a loop, the associated readable stream will always be locked until the reader encounters an error. In this case, calling reader.cancel() will force reader.read() to resolve immediately with { value: undefined, done: true } allowing the loop to call reader.releaseLock().

Closing a serial port is more complicated when using transform streams. See Close a serial port for guidance.

Examples

Closing a port after reading once the stream is done

The following example shows how to close a port after continuously reading data from it, once the stream is done. A keepReading flag controls when to stop reading. A button click sets keepReading to false and cancels the reader, which causes reader.read() to resolve immediately so the loop can release the lock and close() can be called.

// Without transform streams.

let keepReading = true;
let reader;

async function readUntilClosed() {
  while (port.readable && keepReading) {
    reader = port.readable.getReader();
    try {
      while (true) {
        const { value, done } = await reader.read();
        if (done) {
          // reader.cancel() has been called.
          break;
        }
        // value is a Uint8Array.
        console.log(value);
      }
    } catch (error) {
      // Handle error...
    } finally {
      // Allow the serial port to be closed later.
      reader.releaseLock();
    }
  }

  await port.close();
}

const closedPromise = readUntilClosed();

document.querySelector("button").addEventListener("click", async () => {
  // User clicked a button to close the serial port.
  keepReading = false;
  // Force reader.read() to resolve immediately and subsequently
  // call reader.releaseLock() in the loop example above.
  reader.cancel();
  await closedPromise;
});

Specifications

Browser compatibility

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。