hollaex-node-lib 2.12.0 → 2.13.0

package/README.md

@@ -75,7 +75,7 @@ client
 | `getOrders` | <ul><li>**opts**: Object with additional params</li><li>**opts.symbol**: (_optional_) HollaEx trading symbol e.g. `xht-usdt`</li><li>**opts.side**: (_optional_, _enum_=[`buy`, `sell`]) Order side</li><li>**opts.status**: (_optional_) Filter data set `status`</li><li>**opts.limit**: (_optional_, _default_=`50`, _max_=`50`) Number of items to get</li><li>**opts.page**: (_optional_, _default_=`1`) Page number of data</li><li>**opts.orderBy**: (_optional_) Field to order data by</li><li>**opts.order**: (_optional_, _enum_=[`asc`, `desc`])</li><li>**opts.startDate**: (_optional_, _format_=`ISO8601`) Start date of data set</li><li>**opts.endDate**: (_optional_,  _format_=`ISO8601`) End date of data set</li></ul> | Get the list of all user orders. It can be filter by passing the symbol |
 | `createOrder` | <ul><li>**symbol**: HollaEx trading symbol e.g. `xht-usdt`</li><li>**side** (_enum_=[`buy`, `sell`]): Order side</li><li>**size**: Size of order to place</li><li>**type**: (_enum_=[`market`, `limit`] Order type</li><li>**price**: (_required if limit order type_) Order price</li><li>**opts**: Object with additional params</li><li>**opts.stop**: (_optional_) Stop price for order</li><li>**opts.meta**: (_optional_) Object with additional meta configurations</li><li>**opts.meta.post_only**: (_optional_, _default_=`false`) Make post only order </li><li>**opts.meta.note**: (_optional_) Custom note for order</li></ul> | Create a new order |
 | `cancelOrder` | <ul><li>**orderId**: HollaEx Network order ID</li></ul> | Cancel a specific order with its ID |
-| `cancelAllOrders` | <ul><li>**opts**: Object with additional params</li><li>**opts.symbol**: (_optional_) HollaEx trading symbol e.g. `xht-usdt`</li></ul> | Cancel all open order. It can be filter by passing the symbol |
+| `cancelAllOrders` | <ul><li>**symbol**: HollaEx trading symbol e.g. `xht-usdt`</li></ul> | Cancel all the active orders of a user, filtered by currency pair symbol |
 
 ### Websocket
 

package/kit.js

@@ -656,19 +656,17 @@ class HollaExKit {
 	}
 
 	/**
-	 * Cancel all the user's active orders, can filter by currency pair symbol
-	 * @param {object} opts - Optional parameters
-	 * @param {string} opts.symbol - The currency pair symbol to filter by e.g. 'hex-usdt', leave empty to cancel orders of all symbols
+	 * Cancel all the active orders of a user, filtered by currency pair symbol
+	 * @param {string} symbol - The currency pair symbol to filter by e.g. 'hex-usdt'
 	 * @return {array} A JSON array of objects containing the cancelled orders
 	 */
-	cancelAllOrders(opts = { symbol: null }) {
-		const verb = 'DELETE';
-		let path = `${this.baseUrl}/order/all`;
-
-		if (isString(opts.symbol)) {
-			path += `?symbol=${opts.symbol}`;
+	cancelAllOrders(symbol) {
+		if (!isString(symbol)) {
+			throw new Error('You must provide a symbol to cancel all orders for');
 		}
 
+		const verb = 'DELETE';
+		let path = `${this.baseUrl}/order/all?symbol=${symbol}`;
 		const headers = generateHeaders(
 			this.headers,
 			this.apiSecret,
@@ -676,6 +674,7 @@ class HollaExKit {
 			path,
 			this.apiExpiresAfter
 		);
+
 		return createRequest(verb, `${this.apiUrl}${path}`, headers);
 	}
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "hollaex-node-lib",
-	"version": "2.12.0",
+	"version": "2.13.0",
 	"description": "hollaex api and websocket library for nodejs",
 	"main": "index.js",
 	"dependencies": {