Serial: getPorts() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.
Experimental:This is anexperimental technology
Check theBrowser compatibility table carefully before using this in production.
Note: This feature is available inDedicated Web Workers.
ThegetPorts() method of theSerial interface returns aPromise that resolves with an array ofSerialPort objects representing serial ports connected to the host which the origin has permission to access.
Syntax
getPorts()Parameters
None.
Return value
APromise that resolves with an array ofSerialPort objects.
Exceptions
SecurityErrorDOMExceptionThe returned
Promiserejects with this error in either of the following situations:- A
serialPermissions Policy blocks the use of this feature. - A user permission prompt was denied.
- A
Examples
The following example usesgetPorts() to initialize a list of available ports.
navigator.serial.getPorts().then((ports) => { // Initialize the list of available ports with `ports` on page load.});Specifications
| Specification |
|---|
| Web Serial API # dom-serial-getports |