Skip to content

ElectronSerialPort

Unofficial

A serial port available for selection via the Web Serial API.

Import:

import type { ElectronSerialPort } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface ElectronSerialPort

Properties

PropertyTypeDescription
deviceInstanceId?stringA stable identifier on Windows that can be used for device permissions.
displayNamestringA string suitable for display to the user for describing this device.
portIdstringUnique identifier for the port.
portNamestringName of the port.
productIdstringOptional USB product ID.
serialNumberstringThe USB device serial number.
usbDriverName?stringRepresents a single serial port on macOS that can be enumerated by multiple drivers.
vendorIdstringOptional USB vendor ID.

Links to this page: