@ledgerhq/hw-transport-node-hid - npm Package Compare versions

Comparing version 4.37.0-beta.2b8718d2 to 4.37.0

package.json

 {
   "name": "@ledgerhq/hw-transport-node-hid",
-  "version": "4.37.0-beta.2b8718d2",
+  "version": "4.37.0",
   "description": "Ledger Hardware Wallet Node implementation of the communication layer, using node-hid",
@@ -28,5 +28,5 @@ "keywords": [
   "dependencies": {
-    "@ledgerhq/devices": "^4.37.0-beta.2b8718d2",
-    "@ledgerhq/errors": "^4.37.0-beta.2b8718d2",
-    "@ledgerhq/hw-transport": "^4.37.0-beta.2b8718d2",
+    "@ledgerhq/devices": "^4.37.0",
+    "@ledgerhq/errors": "^4.37.0",
+    "@ledgerhq/hw-transport": "^4.37.0",
     "lodash": "^4.17.11",
@@ -37,3 +37,3 @@ "node-hid": "^0.7.6",
   "devDependencies": {
-    "flow-bin": "^0.78.0",
+    "flow-bin": "^0.92.1",
     "flow-typed": "^2.5.1"
@@ -45,4 +45,6 @@ },
     "build": "bash ../../script/build.sh",
-    "watch": "bash ../../script/watch.sh"
-  }
+    "watch": "bash ../../script/watch.sh",
+    "doc": "bash ../../script/doc.sh"
+  },
+  "gitHead": "8b31eec9c71f2b8ec4d1db47c2fb7ae20f188de2"
 }

README.md

 <img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
 
+[Github](https://github.com/LedgerHQ/ledgerjs/),
+[API Doc](http://ledgerhq.github.io/ledgerjs/),
+[Ledger Devs Slack](https://ledger-dev.slack.com/)
+
 ## @ledgerhq/hw-transport-node-hid
 
-Library for Ledger Hardware Wallets.
+Allows to communicate with Ledger Hardware Wallets.
 
-[Github](https://github.com/LedgerHQ/ledgerjs/),
-[API Doc](http://ledgerhq.github.io/ledgerjs/),
-[Ledger Devs Slack](https://ledger-dev.slack.com/)
+**[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)
+    -   [Parameters](#parameters)
+    -   [Examples](#examples)
+    -   [listen](#listen)
+        -   [Parameters](#parameters-1)
+    -   [open](#open)
+        -   [Parameters](#parameters-2)
+
+### TransportNodeHid
+
+**Extends Transport**
+
+node-hid Transport implementation
+
+#### Parameters
+
+-   `device` **HID.HID** 
+
+#### Examples
+
+```javascript
+import TransportNodeHid from "@ledgerhq/hw-transport-node-u2f";
+...
+TransportNodeHid.create().then(transport => ...)
+```
+
+#### 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)** 

src/TransportNodeHid.js

@@ -51,4 +51,4 @@ //@flow
         : debug
-          ? (...log) => console.log("[listenDevices]", ...log)
-          : () => {};
+        ? (...log) => console.log("[listenDevices]", ...log)
+        : () => {};
   };
@@ -55,0 +55,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

636490

increased by1077.77%

Number of package files

17

increased by13.33%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

60

increased by500%

Dependency changes

• Updated@ledgerhq/devices@^4.37.0

• Updated@ledgerhq/errors@^4.37.0

• Updated@ledgerhq/hw-transport@^4.37.0