Rename Device to Port and update related interfaces

Renamed the Device interface to Port, updated all references and documentation to use the new naming, and changed method names and example code accordingly. This improves clarity by aligning terminology with serial port conventions.

Author: Mqxx

src/connection/index.ts

@@ -6,6 +6,6 @@
 
 export { baudrates, type Baudrate } from './baudrates.ts';
 export { dataBits, type DataBits } from './data_bits.ts';
-export { type Device } from './device.ts';
+export { type Port } from './port.ts';
 export { parities, type Parity } from './parities.ts'
 export { stopBits, type StopBits } from './stop_bits.ts'

src/connection/device.ts src/connection/port.tssrc/connection/device.ts renamed to src/connection/port.ts

@@ -1,29 +1,29 @@
 /**
- * This interface represents a device object.
+ * This interface represents a port object.
  */
-export interface Device {
+export interface Port {
   /**
    * The name of the port (ex. `ttyACM2`, `COM5`, ...)
    */
-  port : string,
+  name : string,
 
   /**
    * The full path to the port. (ex. `/dev/ttyACM2`, `\\\\?\\acpi#pnp0501#0#{86e0d1e0-8089-11d0-9ce4-08003e301f73}`, ...)
    */
   path : string,
 
   /**
-   * The manufacturer of the device. (ex. `Arduino (www.arduino.cc)`, `Arduino LLC (www.arduino.cc)`, ...)
+   * The manufacturer of the device, connected to the port. (ex. `Arduino (www.arduino.cc)`, `Arduino LLC (www.arduino.cc)`, ...)
    */
   manufacturer : string | undefined,
 
   /**
-   * The serial number of the device. (ex. `698471028216477376C1`, ...)
+   * The serial number of the device, connected to the port. (ex. `698471028216477376C1`, ...)
    */
   serialNumber : string | undefined,
 
   /**
-   * The Plug and Play ID of the device. (ex. `usb-Arduino__www.arduino.cc__0043_698471028216477376-if00`,
+   * The Plug and Play ID of the device, connected to the port. (ex. `usb-Arduino__www.arduino.cc__0043_698471028216477376-if00`,
    * `USB\\VID_5678&PID_1234\\698471028216477376`, ...)
    */
   pnpId : string | undefined,
@@ -34,12 +34,12 @@ export interface Device {
   locationId : string | undefined,
 
   /**
-   * The product ID of the device. (ex. `1234`)
+   * The product ID of the device, connected to the port. (ex. `1234`)
    */
   productId : string | undefined,
 
   /**
-   * The vendor ID of the device. (ex. `5678`)
+   * The vendor ID of the device, connected to the port. (ex. `5678`)
    */
   vendorId : string | undefined
 }

src/index.ts

@@ -3,10 +3,10 @@
  * 
  * @example
  * ```ts
- * const devices = await Serial.getDevices();
+ * const ports = await Serial.listPorts();
  * 
- * devices.forEach((device) => {
- *   console.log(`Found device "${device.manufacturer}" on port "${device.port}".`);
+ * ports.forEach((port) => {
+ *   console.log(`Found device "${port.manufacturer}" on port "${port.name}".`);
  *   // Found device "Arduino (www.arduino.cc)" on port "COM5".
  * });
  * 

src/serial.ts

@@ -1,4 +1,4 @@
-import { dataBits, parities, stopBits, type Device } from './connection/index.ts';
+import { dataBits, parities, stopBits, type Port } from './connection/index.ts';
 import type { read, write } from './operations/index.ts';
 import type { Options } from './options.ts';
 
@@ -8,10 +8,10 @@ import type { Options } from './options.ts';
  * 
  * @example
  * ```ts
- * const devices = await Serial.getDevices();
+ * const ports = await Serial.listPorts();
  * 
- * devices.forEach((device) => {
- *   console.log(`Found device "${device.manufacturer}" on port "${device.port}".`);
+ * ports.forEach((port) => {
+ *   console.log(`Found device "${port.manufacturer}" on port "${port.name}".`);
  *   // Found device "Arduino (www.arduino.cc)" on port "COM5".
  * });
  * 
@@ -65,20 +65,20 @@ export class Serial {
   }
 
   /**
-   * Get a list of available serial devices.
+   * List all available serial ports.
    * 
    * @example
    * ```ts
-   * const devices = await Serial.getDevices();
+   * const ports = await Serial.listPorts();
    * 
-   * devices.forEach((device) => {
-   *   console.log(`Found device "${device.manufacturer}" on port "${device.port}".`);
+   * ports.forEach((port) => {
+   *   console.log(`Found device "${port.manufacturer}" on port "${port.name}".`);
    *   // Found device "Arduino (www.arduino.cc)" on port "COM5".
    * });
    * ```
-   * @returns A list of available devices.
+   * @returns A list of available ports.
    */
-  public static getDevices() : Promise<Device[]> {
+  public static listPorts() : Promise<Port[]> {
     return new Promise((resolve) => resolve([]))
   }