mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

docs: fix SerialPort typing (#38544)

Browse source
This commit is contained in:
David Sanders 2023-06-05 14:58:30 +08:00 committed by GitHub
parent 8fdd7de3d2
commit 4c89061e0e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/api/structures/serial-port.md
View file

@ -2,9 +2,9 @@
* `portId` string - Unique identifier for the port. * `portId` string - Unique identifier for the port.
* `portName` string - Name of the port. * `portName` string - Name of the port.
* `displayName` string - A string suitable for display to the user for describing this device. * `displayName` string (optional) - A string suitable for display to the user for describing this device.
* `vendorId` string - Optional USB vendor ID. * `vendorId` string (optional) - The USB vendor ID.
* `productId` string - Optional USB product ID. * `productId` string (optional) - The USB product ID.
* `serialNumber` string - The USB device serial number. * `serialNumber` string (optional) - The USB device serial number.
* `usbDriverName` string (optional) - Represents a single serial port on macOS can be enumerated by multiple drivers. * `usbDriverName` string (optional) _macOS_ - Represents a single serial port on macOS can be enumerated by multiple drivers.
* `deviceInstanceId` string (optional) - A stable identifier on Windows that can be used for device permissions. * `deviceInstanceId` string (optional) _Windows_ - A stable identifier on Windows that can be used for device permissions.