README.md

Github, Ledger Devs Slack

@ledgerhq/hw-transport-node-hid

Allows to communicate with Ledger Hardware Wallets.

[Node]/Electron (HID) – uses node-hid and usb.

API

Table of Contents

• TransportNodeHid
  • Examples
  • isSupported
  • list
  • setListenDevicesDebounce
    • Parameters
  • setListenDevicesPollingSkip
    • Parameters
  • setListenDevicesDebug
  • listen
    • Parameters
  • open
    • Parameters

TransportNodeHid

Extends TransportNodeHidNoEvents

node-hid Transport implementation

Examples

import TransportNodeHid from "@ledgerhq/hw-transport-node-hid";
...
TransportNodeHid.create().then(transport => ...)

isSupported

list

setListenDevicesDebounce

Parameters

• delay number

setListenDevicesPollingSkip

Parameters

• conditionToSkip function (): boolean

setListenDevicesDebug

listen

Parameters

• observer Observer<DescriptorEvent<string?>>

Returns Subscription

open

if path="" is not provided, the library will take the first device

Parameters

• path string?