Serial: getPorts() method - Web APIs | MDN

Syntax

Parameters

None.

Return value

A Promise that resolves with an array of SerialPort objects.

Exceptions

SecurityError DOMException

The returned Promise rejects with this error in either of the following situations:

Examples

The following example uses getPorts() to initialize a list of available ports.

js

navigator.serial.getPorts().then((ports) => {
  // Initialize the list of available ports with `ports` on page load.
});

Specifications

Specification
Web Serial API
# dom-serial-getports

Browser compatibility

Help improve MDN

Learn how to contribute

This page was last modified on by MDN contributors.