bitmex-candle - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

dist/bitmex-candle.d.ts

@@ -6,4 +6,59 @@ /**
 /**
- * TODO: document
+ * An atomic unit of time-series data as returned by the BitMEX
+ * exchange API.
  */
-export default function bitmexCandle(): void;
+interface Candle {
+    /**
+     * Time that the current Candle closed, in ISO 8601 format.
+     */
+    timestamp: string;
+    /**
+     * Opening value of current Candle.
+     */
+    open: number;
+    /**
+     * Highest value observed during current Candle.
+     */
+    high: number;
+    /**
+     * Lowest value observed during current Candle.
+     */
+    low: number;
+    /**
+     * Closing value of current Candle.
+     */
+    close: number;
+    /**
+     * Volume observed during current Candle.
+     */
+    volume: number;
+    /**
+     * Instrument symbol.
+     */
+    symbol?: string;
+    /**
+     * Number of trades recorded during current Candle.
+     */
+    trades?: number;
+    /**
+     * Volume-weighted average price.
+     */
+    vwap?: number;
+    /**
+     *
+     */
+    lastSize?: number;
+    /**
+     * Number of contracts exchanged during current Candle.
+     */
+    turnover?: number;
+    /**
+     *
+     */
+    homeNotional?: number;
+    /**
+     *
+     */
+    foreignNotional?: number;
+}
+export default Candle;

dist/bitmex-candle.js

@@ -7,8 +7,1 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * TODO: document
- */
-function bitmexCandle() {
-    // TODO: implement
-}
-exports.default = bitmexCandle;

package.json

 {
   "name": "bitmex-candle",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Interface for BitMEX candle",
@@ -8,3 +8,5 @@ "main": "dist/bitmex-candle.js",
   "scripts": {
-    "install": "tsc",
+    "prepublishOnly": "npm run compile",
+    "compile": "npm run clean && tsc",
+    "clean": "rm -rf  dist",
     "test": "ava",
@@ -16,2 +18,5 @@ "watch:test": "nodemon -e 'ts json' -x 'npm test || true'",
   },
+  "files": [
+    "dist/"
+  ],
   "husky": {
@@ -37,7 +42,4 @@ "hooks": {
   "homepage": "https://github.com/strong-roots-capital/bitmex-candle",
-  "dependencies": {
+  "devDependencies": {
     "@types/node": "^10.12.18",
-    "typescript": "^3.2.2"
-  },
-  "devDependencies": {
     "ava": "^1.0.0",
@@ -47,3 +49,4 @@ "husky": "^1.3.1",
     "typedoc": "^0.13.0",
-    "typedoc-plugin-markdown": "^1.1.20"
+    "typedoc-plugin-markdown": "^1.1.20",
+    "typescript": "^3.2.2"
   },
@@ -50,0 +53,0 @@ "ava": {

New 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

Fixed alerts

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Found 1 instance in 1 package

Improved metrics

Dependency count

0

decreased by-100%

Number of high supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

4668

decreased by-66.62%

Dev dependency count

7

increased by40%

Number of package files

4

decreased by-60%

Lines of code

69

decreased by-64.62%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• - Removed@types/node@^10.12.18

• - Removedtypescript@^3.2.2

• - Removed@types/node@10.17.60(transitive)

• - Removedtypescript@3.9.10(transitive)