Serial: getPorts() method

The getPorts() method of the Serial interface returns a Promise that resolves with an array of SerialPort objects representing serial ports connected to the host which the origin has permission to access.

Syntax

getPorts()

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:

• A serial Permissions Policy blocks the use of this feature.
• A user permission prompt was denied.

Examples

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

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

Specifications

Browser compatibility