UNPKG

@aleworm/hw-transport-node-hid

Version:

Ledger Hardware Wallet Node implementation of the communication layer, using node-hid

79 lines (48 loc) 2.09 kB
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" /> [Github](https://github.com/LedgerHQ/ledgerjs/), [Ledger Devs Slack](https://ledger-dev.slack.com/) ## @ledgerhq/hw-transport-node-hid Allows to communicate with Ledger Hardware Wallets. **[Node]**/Electron **(HID)** – uses `node-hid` and `usb`. ## API <!-- Generated by documentation.js. Update this documentation by updating the source code. --> #### Table of Contents - [TransportNodeHid](#transportnodehid) - [Examples](#examples) - [isSupported](#issupported) - [list](#list) - [setListenDevicesDebounce](#setlistendevicesdebounce) - [Parameters](#parameters) - [setListenDevicesPollingSkip](#setlistendevicespollingskip) - [Parameters](#parameters-1) - [setListenDevicesDebug](#setlistendevicesdebug) - [listen](#listen) - [Parameters](#parameters-2) - [open](#open) - [Parameters](#parameters-3) ### TransportNodeHid **Extends TransportNodeHidNoEvents** node-hid Transport implementation #### Examples ```javascript import TransportNodeHid from "@ledgerhq/hw-transport-node-hid"; ... TransportNodeHid.create().then(transport => ...) ``` #### isSupported #### list #### setListenDevicesDebounce ##### Parameters - `delay` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** #### setListenDevicesPollingSkip ##### Parameters - `conditionToSkip` **function (): [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** #### setListenDevicesDebug #### listen ##### Parameters - `observer` **Observer&lt;DescriptorEvent&lt;[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?>>** Returns **Subscription** #### open if path="" is not provided, the library will take the first device ##### Parameters - `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**