SerialPort: forget() 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 in secure contexts (HTTPS), in some or all supporting browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Note: This feature is available in Dedicated Web Workers.

The SerialPort.forget() method of the SerialPort interface returns a Promise that resolves when access to the serial port is revoked.

Description

A website can clean up permissions to access a serial port it is no longer interested in retaining by calling SerialPort.forget(). Calling this "forgets" the device, resetting any previously-set permissions so the calling site can no longer communicate with the port.

For example, for an educational web application used on a shared computer with many devices, a large number of accumulated user-generated permissions creates a poor user experience.

Syntax

js
forget()

Parameters

None.

Return value

A Promise that resolves with undefined once the connection is revoked.

Specifications

Specification
Web Serial API
# dom-serialport-forget

Browser compatibility

BCD tables only load in the browser