Skip to content

Commit 8bc3eea

Browse files
committed
Update .list docs to be up to date
1 parent 39946c4 commit 8bc3eea

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,15 +182,15 @@ serialPort.open(function (error) {
182182

183183
Retrieves a list of available serial ports with metadata.
184184

185-
* `callback` is a required function that looks should look like: `function (err, ports) { ... }`. `ports` will be an array of objects with port info. Only the `comName` is guaranteed, all the other fields are retrieved as available. The `comName` is either the path or identifier (eg `COM1`) used to open the serialport.
185+
* `callback` is a required function that looks should look like: `function (err, ports) { ... }`. `ports` will be an array of objects with port info. Only the `comName` is guaranteed, all the other fields undefined if unavailable. The `comName` is either the path or identifier (eg `COM1`) used to open the serialport.
186186

187187
```js
188188
// example port information
189189
{
190190
comName: '/dev/cu.usbmodem1421',
191191
manufacturer: 'Arduino (www.arduino.cc)',
192192
serialNumber: '757533138333964011C1',
193-
pnpId: '',
193+
pnpId: undefined,
194194
locationId: '0x14200000',
195195
vendorId: '0x2341',
196196
productId: '0x0043'

0 commit comments

Comments
 (0)