bybit-api - npm Package Compare versions

Comparing version 1.3.0-beta.2 to 1.3.1

lib/websocket-client.js

@@ -80,6 +80,2 @@ "use strict";
                 const ws = new isomorphic_ws_1.default(url);
-                // ws.onopen!(this._wsOpenHandler.bind(this));
-                // ws.onmessage!(this._wsMessageHandler.bind(this));
-                // ws.onerror!(this._wsOnErrorHandler.bind(this));
-                // ws.onclose!(this._wsCloseHandler.bind(this));
                 ws.onopen = this._wsOpenHandler.bind(this);
@@ -86,0 +82,0 @@ ws.onmessage = this._wsMessageHandler.bind(this);

package.json

 {
   "name": "bybit-api",
-  "version": "1.3.0-beta.2",
+  "version": "1.3.1",
   "description": "A production-ready Node.js connector for the Bybit APIs and WebSockets",
@@ -9,4 +9,3 @@ "main": "lib/index.js",
     "lib/*",
-    "index.js",
-    "dist/*"
+    "index.js"
   ],
@@ -19,3 +18,2 @@ "scripts": {
     "pack": "webpack --config webpack/webpack.config.js",
-    "prepush": "npm run build",
     "prepublish": "npm run build",
@@ -22,0 +20,0 @@ "betapublish": "npm publish --tag beta"

README.md

@@ -8,3 +8,3 @@ # bybit-api
 
-A production-ready Node.js connector for the Bybit APIs and WebSockets.
+A production-ready Node.js connector for the Bybit APIs and WebSockets, with TypeScript & browser support.
 
@@ -14,7 +14,2 @@ ## Installation
 
-## Usage
-Create API credentials at Bybit
-- [Livenet](https://bybit.com/app/user/api-management?affiliate_id=9410&language=en-US&group_id=0&group_type=1)
-- [Testnet](https://testnet.bybit.com/app/user/api-management)
-
 ## Issues & Discussion
@@ -35,6 +30,19 @@ - Issues? Check the [issues tab](https://github.com/tiagosiebler/bybit-api/issues).
 
+## Usage
+Create API credentials at Bybit
+- [Livenet](https://bybit.com/app/user/api-management?affiliate_id=9410&language=en-US&group_id=0&group_type=1)
+- [Testnet](https://testnet.bybit.com/app/user/api-management)
+
+### Browser Usage
+Build a bundle using webpack:
+- `npm install`
+- `npm build`
+- `npm pack`
+
+The bundle can be found in `dist/`. Altough usage should be largely consistent, smaller differences will exist. Documentation is still TODO.
+
 ### Inverse Contracts
 #### Rest client
 ```javascript
-const {RestClient} = require('bybit-api');
+const { RestClient } = require('bybit-api');
 
@@ -86,7 +94,7 @@ const API_KEY = 'xxx';
 
-See inverse [rest-client.js](./lib/rest-client.js) for further information.
+See inverse [rest-client.ts](./src/rest-client.ts) for further information.
 
 #### Websocket client
 ```javascript
-const {WebsocketClient} = require('bybit-api');
+const { WebsocketClient } = require('bybit-api');
 
@@ -149,3 +157,3 @@ const API_KEY = 'xxx';
 ```
-See inverse [websocket-client.js](./lib/websocket-client.js) & [ws api docs](./doc/websocket-client.md) for further information.
+See inverse [websocket-client.ts](./src/websocket-client.ts) for further information.
 
@@ -152,0 +160,0 @@ ### Customise Logging

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

186

increased by4.49%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

69180

decreased by-0.21%

Lines of code

1151

decreased by-0.35%

No dependency changes