binance - npm Package Compare versions

Comparing version 2.2.6 to 2.2.7

lib/types/websockets.d.ts

@@ -10,3 +10,3 @@ import { WsKey } from '../websocket-client';
 export declare type WsRawMessage = WsMessageKlineRaw | WsMessageAggTradeRaw | WsMessageTradeRaw | WsMessage24hrMiniTickerRaw | WsMessage24hrMiniTickerRaw[] | WsMessage24hrTickerRaw | WsMessage24hrTickerRaw[] | WsMessageBookTickerEventRaw | WsMessagePartialBookDepthEventRaw | WsRawSpotUserDataEventRaw | WsMessageIndexPriceUpdateEventRaw | WsMessageFuturesUserDataAccountUpdateRaw | WsMessageFuturesUserDataListenKeyExpiredRaw | WsMessageFuturesUserDataMarginCallRaw | WsMessageFuturesUserDataOrderTradeUpdateEventRaw | WsMessageFuturesUserDataAccountConfigUpdateEventRaw;
-export declare type WsFormattedMessage = WsMessageKlineFormatted | WsMessageAggTradeFormatted | WsMessageTradeFormatted | WsMessage24hrMiniTickerFormatted | WsMessage24hrMiniTickerFormatted[] | WsMessage24hrTickerFormatted | WsMessage24hrTickerFormatted[] | WsMessageBookTickerEventFormatted | WsMessagePartialBookDepthEventFormatted | WsMessageSpotUserDataEventFormatted | WsMessageFuturesUserDataEventFormatted | WsMessageIndexPriceUpdateEventFormatted | WsMessageMarkPriceUpdateEventFormatted | WsMessageMarkPriceUpdateEventFormatted[] | WsMessageForceOrderFormatted;
+export declare type WsFormattedMessage = WsUserDataEvents | WsMessageKlineFormatted | WsMessageAggTradeFormatted | WsMessageTradeFormatted | WsMessage24hrMiniTickerFormatted | WsMessage24hrMiniTickerFormatted[] | WsMessage24hrTickerFormatted | WsMessage24hrTickerFormatted[] | WsMessageBookTickerEventFormatted | WsMessagePartialBookDepthEventFormatted | WsMessageIndexPriceUpdateEventFormatted | WsMessageMarkPriceUpdateEventFormatted | WsMessageMarkPriceUpdateEventFormatted[] | WsMessageForceOrderFormatted;
 export declare type WsUserDataEvents = WsMessageSpotUserDataEventFormatted | WsMessageFuturesUserDataEventFormatted;
@@ -13,0 +13,0 @@ interface WsSharedBase {

lib/util/typeGuards.d.ts

@@ -1,2 +0,12 @@
-import { WsFormattedMessage, WsMessage24hrMiniTickerRaw, WsMessage24hrTickerFormatted, WsMessageFuturesUserDataAccountConfigUpdateEventRaw, WsMessageFuturesUserDataAccountUpdateRaw, WsMessageFuturesUserDataEventFormatted, WsMessageFuturesUserDataOrderTradeUpdateEventRaw, WsMessageKlineFormatted, WsMessageKlineRaw, WsMessageMarkPriceUpdateEventFormatted, WsMessageSpotUserDataEventFormatted, WsMessageTradeFormatted, WsRawMessage, WsUserDataEvents } from '..';
+import { WsFormattedMessage, WsMessage24hrMiniTickerRaw, WsMessage24hrTickerFormatted, WsMessageAggTradeFormatted, WsMessageFuturesUserDataAccountConfigUpdateEventFormatted, WsMessageFuturesUserDataAccountConfigUpdateEventRaw, WsMessageFuturesUserDataAccountUpdateFormatted, WsMessageFuturesUserDataAccountUpdateRaw, WsMessageFuturesUserDataEventFormatted, WsMessageFuturesUserDataListenKeyExpiredFormatted, WsMessageFuturesUserDataMarginCallFormatted, WsMessageFuturesUserDataOrderTradeUpdateEventRaw, WsMessageFuturesUserDataTradeUpdateEventFormatted, WsMessageKlineFormatted, WsMessageKlineRaw, WsMessageMarkPriceUpdateEventFormatted, WsMessageSpotBalanceUpdateFormatted, WsMessageSpotOutboundAccountPositionFormatted, WsMessageSpotUserDataEventFormatted, WsMessageSpotUserDataExecutionReportEventFormatted, WsMessageSpotUserDataListStatusEventFormatted, WsMessageTradeFormatted, WsRawMessage, WsUserDataEvents } from '../types/websockets';
+/**
+ * Use type guards to narrow down types with minimal efforts.
+ *
+ * The file is organised by Typeguards starting with `WsFormattedMessage` typeguards in the first half
+ * and `WsRawMessage` typeguards in the second half.
+ *
+ */
+/**
+ * Typeguards for WsFormattedMessage event types:
+ */
 export declare function isWsFormattedMarkPriceUpdateEvent(data: WsFormattedMessage): data is WsMessageMarkPriceUpdateEventFormatted;
@@ -10,6 +20,22 @@ export declare function isWsFormattedMarkPriceUpdateArray(data: WsFormattedMessage): data is WsMessageMarkPriceUpdateEventFormatted[];
 export declare function isWsFormatted24hrTickerArray(data: WsFormattedMessage): data is WsMessage24hrTickerFormatted[];
+/**
+ * Typeguard to validate a 'Compressed/Aggregate' trade
+ */
+export declare function isWsAggTradeFormatted(data: WsFormattedMessage): data is WsMessageAggTradeFormatted;
 export declare function isWsFormattedUserDataEvent(data: WsFormattedMessage): data is WsUserDataEvents;
 export declare function isWsFormattedSpotUserDataEvent(data: WsFormattedMessage): data is WsMessageSpotUserDataEventFormatted;
 export declare function isWsFormattedFuturesUserDataEvent(data: WsFormattedMessage): data is WsMessageFuturesUserDataEventFormatted;
+export declare function isWsFormattedSpotUserDataExecutionReport(data: WsFormattedMessage): data is WsMessageSpotUserDataExecutionReportEventFormatted;
+export declare function isWsFormattedSpotOutboundAccountPosition(data: WsFormattedMessage): data is WsMessageSpotOutboundAccountPositionFormatted;
+export declare function isWsFormattedSpotBalanceUpdate(data: WsFormattedMessage): data is WsMessageSpotBalanceUpdateFormatted;
+export declare function isWsFormattedSpotUserDataListStatusEvent(data: WsFormattedMessage): data is WsMessageSpotUserDataListStatusEventFormatted;
+export declare function isWsFormattedFuturesUserDataAccountUpdate(data: WsFormattedMessage): data is WsMessageFuturesUserDataAccountUpdateFormatted;
+export declare function isWsFormattedFuturesUserDataMarginCall(data: WsFormattedMessage): data is WsMessageFuturesUserDataMarginCallFormatted;
+export declare function isWsFormattedFuturesUserDataTradeUpdateEvent(data: WsFormattedMessage): data is WsMessageFuturesUserDataTradeUpdateEventFormatted;
+export declare function isWsFormattedFuturesUserDataAccountConfigUpdateEvent(data: WsFormattedMessage): data is WsMessageFuturesUserDataAccountConfigUpdateEventFormatted;
+export declare function isWsFormattedFuturesUserDataListenKeyExpired(data: WsFormattedMessage): data is WsMessageFuturesUserDataListenKeyExpiredFormatted;
 /**
+ * Typeguards for WsRawMessage event types:
+ */
+/**
  * Typeguard to validate all symbol 24hrMiniTicker raw event
@@ -16,0 +42,0 @@ */

lib/util/typeGuards.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAccountUpdateRaw = exports.isAccountConfigUpdateRaw = exports.isOrderTradeUpdateRaw = exports.isKlineRaw = exports.is24hrMiniTickerRaw = exports.isAll24hrMiniTickerRaw = exports.isWsFormattedFuturesUserDataEvent = exports.isWsFormattedSpotUserDataEvent = exports.isWsFormattedUserDataEvent = exports.isWsFormatted24hrTickerArray = exports.isWsFormatted24hrTicker = exports.isWsFormattedKline = exports.isWsFormattedTrade = exports.isWsFormattedMarkPriceUpdate = exports.isWsFormattedMarkPriceUpdateArray = exports.isWsFormattedMarkPriceUpdateEvent = void 0;
-/*
-  Use type guards to narrow down types with minimal efforts.
-*/
+exports.isAccountUpdateRaw = exports.isAccountConfigUpdateRaw = exports.isOrderTradeUpdateRaw = exports.isKlineRaw = exports.is24hrMiniTickerRaw = exports.isAll24hrMiniTickerRaw = exports.isWsFormattedFuturesUserDataListenKeyExpired = exports.isWsFormattedFuturesUserDataAccountConfigUpdateEvent = exports.isWsFormattedFuturesUserDataTradeUpdateEvent = exports.isWsFormattedFuturesUserDataMarginCall = exports.isWsFormattedFuturesUserDataAccountUpdate = exports.isWsFormattedSpotUserDataListStatusEvent = exports.isWsFormattedSpotBalanceUpdate = exports.isWsFormattedSpotOutboundAccountPosition = exports.isWsFormattedSpotUserDataExecutionReport = exports.isWsFormattedFuturesUserDataEvent = exports.isWsFormattedSpotUserDataEvent = exports.isWsFormattedUserDataEvent = exports.isWsAggTradeFormatted = exports.isWsFormatted24hrTickerArray = exports.isWsFormatted24hrTicker = exports.isWsFormattedKline = exports.isWsFormattedTrade = exports.isWsFormattedMarkPriceUpdate = exports.isWsFormattedMarkPriceUpdateArray = exports.isWsFormattedMarkPriceUpdateEvent = void 0;
+/**
+ * Use type guards to narrow down types with minimal efforts.
+ *
+ * The file is organised by Typeguards starting with `WsFormattedMessage` typeguards in the first half
+ * and `WsRawMessage` typeguards in the second half.
+ *
+ */
+/**
+ * Typeguards for WsFormattedMessage event types:
+ */
 function isWsFormattedMarkPriceUpdateEvent(data) {
@@ -38,2 +45,9 @@ return !Array.isArray(data) && data.eventType === 'markPriceUpdate';
 exports.isWsFormatted24hrTickerArray = isWsFormatted24hrTickerArray;
+/**
+ * Typeguard to validate a 'Compressed/Aggregate' trade
+ */
+function isWsAggTradeFormatted(data) {
+    return !Array.isArray(data) && data.eventType === 'aggTrade';
+}
+exports.isWsAggTradeFormatted = isWsAggTradeFormatted;
 function isWsFormattedUserDataEvent(data) {
@@ -51,3 +65,42 @@ return !Array.isArray(data) && data.wsKey.includes('userData');
 exports.isWsFormattedFuturesUserDataEvent = isWsFormattedFuturesUserDataEvent;
+function isWsFormattedSpotUserDataExecutionReport(data) {
+    return isWsFormattedSpotUserDataEvent(data) && data.eventType === 'executionReport';
+}
+exports.isWsFormattedSpotUserDataExecutionReport = isWsFormattedSpotUserDataExecutionReport;
+function isWsFormattedSpotOutboundAccountPosition(data) {
+    return isWsFormattedSpotUserDataEvent(data) && data.eventType === 'outboundAccountPosition';
+}
+exports.isWsFormattedSpotOutboundAccountPosition = isWsFormattedSpotOutboundAccountPosition;
+function isWsFormattedSpotBalanceUpdate(data) {
+    return isWsFormattedSpotUserDataEvent(data) && data.eventType === 'balanceUpdate';
+}
+exports.isWsFormattedSpotBalanceUpdate = isWsFormattedSpotBalanceUpdate;
+function isWsFormattedSpotUserDataListStatusEvent(data) {
+    return isWsFormattedSpotUserDataEvent(data) && data.eventType === 'listStatus';
+}
+exports.isWsFormattedSpotUserDataListStatusEvent = isWsFormattedSpotUserDataListStatusEvent;
+function isWsFormattedFuturesUserDataAccountUpdate(data) {
+    return isWsFormattedFuturesUserDataEvent(data) && data.eventType === 'ACCOUNT_UPDATE';
+}
+exports.isWsFormattedFuturesUserDataAccountUpdate = isWsFormattedFuturesUserDataAccountUpdate;
+function isWsFormattedFuturesUserDataMarginCall(data) {
+    return isWsFormattedFuturesUserDataEvent(data) && data.eventType === 'MARGIN_CALL';
+}
+exports.isWsFormattedFuturesUserDataMarginCall = isWsFormattedFuturesUserDataMarginCall;
+function isWsFormattedFuturesUserDataTradeUpdateEvent(data) {
+    return isWsFormattedFuturesUserDataEvent(data) && data.eventType === 'ORDER_TRADE_UPDATE';
+}
+exports.isWsFormattedFuturesUserDataTradeUpdateEvent = isWsFormattedFuturesUserDataTradeUpdateEvent;
+function isWsFormattedFuturesUserDataAccountConfigUpdateEvent(data) {
+    return isWsFormattedFuturesUserDataEvent(data) && data.eventType === 'ACCOUNT_CONFIG_UPDATE';
+}
+exports.isWsFormattedFuturesUserDataAccountConfigUpdateEvent = isWsFormattedFuturesUserDataAccountConfigUpdateEvent;
+function isWsFormattedFuturesUserDataListenKeyExpired(data) {
+    return isWsFormattedFuturesUserDataEvent(data) && data.eventType === 'listenKeyExpired';
+}
+exports.isWsFormattedFuturesUserDataListenKeyExpired = isWsFormattedFuturesUserDataListenKeyExpired;
 /**
+ * Typeguards for WsRawMessage event types:
+ */
+/**
  * Typeguard to validate all symbol 24hrMiniTicker raw event
@@ -54,0 +107,0 @@ */

package.json

 {
   "name": "binance",
-  "version": "2.2.6",
+  "version": "2.2.7",
   "description": "Node.js connector for Binance's REST APIs and WebSockets, with TypeScript & integration tests.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

No alert changes

Improved metrics

Total package byte prevSize

413324

increased by1.66%

Lines of code

7513

increased by1.09%

No dependency changes