UNPKG

@ledgerhq/hw-transport-node-hid

Version:

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

80 lines (49 loc) 2.4 kB
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" /> [GitHub](https://github.com/LedgerHQ/ledger-live/), [Ledger Devs Discord](https://developers.ledger.com/discord-pro), [Developer Portal](https://developers.ledger.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)**&#x20; #### setListenDevicesPollingSkip ##### Parameters * `conditionToSkip` **function (): [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20; #### setListenDevicesDebug #### listen ##### Parameters * `observer` **Observer\<DescriptorEvent<([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>>**&#x20; Returns **Subscription**&#x20; #### 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) | null | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))**&#x20;