@ledgerhq/types-devices

@ledgerhq/types-devices

Ledger types for devices and transport.

API

#### Table of Contents

* DeviceModelId
* DevicesWithTouchScreen
* DeviceModel
* ChargingModes
* BatteryStatusFlags
* BluetoothInfos
* Subscription
* Properties
* Device
* Observer
* send
* Parameters
* on
* off
* setExchangeTimeout
* setExchangeUnresponsiveTimeout

$3

DeviceModelId is a unique identifier to identify the model of a Ledger hardware wallet.

$3

DevicesWithTouchScreen is a list of DeviceModelId of whom the Ledger device can present a QR code.

Type: Array<DeviceModelId>

$3

a DeviceModel contains all the information of a specific Ledger hardware wallet model.

$3

$3

Series of flags to represent the health status of the Ledger hardware wallet battery.

$3

$3

represent an ongoing job that can be stopped with .unsubscribe()

Type: {unsubscribe: function (): void}

#### Properties

* unsubscribe function (): void

$3

data about the device. not yet typed

Type: any

$3

Type: Readonly<{next: function (event: Ev): any, error: function (e: any): any, complete: function (): any}>

$3

wrapper on top of exchange to simplify work of the implementation.

Type: function (cla: number, ins: number, p1: number, p2: number, data: Buffer, statusList: Array<number>): Promise<Buffer>

#### Parameters

* cla
* ins
* p1
* p2
* data
* statusList is a list of accepted status code (shorts). \[0x9000] by default

Returns any a Promise of response buffer

$3

Listen to an event on an instance of transport.
Transport implementation can have specific events. Here is the common events:

* "disconnect" : triggered if Transport is disconnected

Type: function (eventName: string, cb: function (...args: Array\): any): void

$3

Stop listening to an event on an instance of transport.

Type: function (eventName: string, cb: function (...args: Array\): any): void

$3

Set a timeout (in milliseconds) for the exchange call. Only some transport might implement it. (e.g. U2F)

Type: function (exchangeTimeout: number): void

$3

Define the delay before emitting "unresponsive" on an exchange that does not respond

Type: function (unresponsiveTimeout: number): void