chore: doc

SuperFlyTV · Jan 11, 2024 · 4aac9f4 · 4aac9f4
1 parent b552fd9
commit 4aac9f4
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/core/src/xkeys.ts b/packages/core/src/xkeys.ts
@@ -47,6 +47,9 @@ export class XKeys extends EventEmitter {
 	static get vendorId(): number {
 		return XKEYS_VENDOR_ID
 	}
+	/**
+	 * Takes a HID device as input. If the HID device is NOT an X-Keys returns null, otherwise some info about it.
+	 */
 	static filterDevice(deviceInfo: DeviceInfo): { product: Product; productId: number; interface: number } | null {
 		if (deviceInfo.vendorId !== XKEYS_VENDOR_ID) return null