We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 146eba4 commit 0092d4bCopy full SHA for 0092d4b
packages/companion-surface-base/src/surface-api/plugin.ts
@@ -95,7 +95,11 @@ export interface DiscoveredSurfaceInfo<TInfo> {
95
export interface DetectionSurfaceInfo<TInfo> extends DiscoveredSurfaceInfo<TInfo> {
96
/**
97
* A stable unique identifier for the device.
98
- * Typically the device path if usb.
+ *
99
+ * This is the same logical concept that other interfaces may refer to as `devicePath`,
100
+ * but is named `deviceHandle` here because, depending on the transport or platform,
101
+ * it may not literally be a filesystem path. For USB devices it will typically be the
102
+ * device path, while for other transports it can be another stable identifier.
103
*/
104
deviceHandle: string
105
}
0 commit comments