Skip to content
This repository has been archived by the owner on Mar 7, 2023. It is now read-only.

Add type definitions #66

Merged
merged 2 commits into from
Jul 23, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// Type definitions for usb-detection 3.1.0
// Project: https://github.com/MadLittleMods/node-usb-detection
// Definitions by: Rob Moran <https://github.com/thegecko>

export interface Device {
locationId: number;
vendorId: number;
productId: number;
deviceName: string;
manufacturer: string;
serialNumber: string;
deviceAddress: number;
}

export function find(vid: number, pid: number, callback: (error: any, devices: Device[]) => any): void;
export function find(vid: number, callback: (error: any, devices: Device[]) => any): void;
export function find(callback: (error: any, devices: Device[]) => any): void;
export function find(): Promise<Device[]>;

export function startMonitoring(): void;
export function stopMonitoring(): void;
export function on(event: string, callback: (device: Device) => void): void;

export const version: number;
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"version": "3.1.0",
"description": "Listen to USB devices and detect changes on them.",
"main": "index.js",
"types": "index.d.ts",
"gypfile": true,
"scripts": {
"install": "prebuild-install || node-gyp rebuild",
Expand Down