feat: method aliases

Author: Insmael

lib/client.ts

@@ -88,6 +88,97 @@ export class Client {
     return fromSnakeCaseToCamelCase(response);
   }
 
+
+  //////////////
+  // ALIASES //
+  /////////////
+  // MARKET DATA
+
+  /**
+   * alias of {@link getTicker}
+   */
+  getTickerBySymbol = this.getTicker;
+  /**
+   * alias of {@link getTicker}
+   */
+  getTickerOfSymbol = this.getTicker;
+  /**
+   * alias of {@link getTickerLastPrice}
+   */
+  getTickerPriceBySymbol = this.getTickerLastPrice;
+  /**
+   * alias of {@link getTickerLastPrice}
+   */
+  getTickerPriceOfSymbol = this.getTickerLastPrice;
+  /**
+   * Alias of {@link getTradesBySymbol}
+   */
+  getTradesOfSymbol = this.getTradesBySymbol;
+  /**
+   * alias of {@link getOrderBook}
+   */
+  getOrderbookBySymbol = this.getOrderBook;
+  /** 
+   * alias of {@link getOrderBook}
+   */
+  getOrderbookOfSymbol = this.getOrderBook;
+  /**
+   * alias of {@link getOrderBookVolume}
+   */
+  getOrderBookVolumeBySymbol = this.getOrderBookVolume;
+  /**
+   * alias of {@link getOrderBookVolume}
+   */
+  getOrderBookVolumeOfSymbol = this.getOrderBookVolume;
+  /**
+   * alias of {@link getCandlesBySymbol}
+   */
+  getCandlesOfSymbol = this.getCandlesBySymbol;
+  /**
+   * alias of {@link getConvertedCandlesBySymbol}
+   */
+  getConvertedCandlesOfSymbol = this.getConvertedCandlesBySymbol;
+
+  // SPOT TRADING 
+
+  /**
+   * alias of {@link getSpotTradingBalance}
+   */
+  getSpotTradingBalanceOfCurrency = this.getSpotTradingBalance;
+  /**
+   * alias of {@link getSpotTradingBalance}
+   */
+  getSpotTradingBalanceByCurrency = this.getSpotTradingBalance;
+  /**
+   * alias of {@link getTradingCommission}
+   */
+  getTradingCommissionOfSymbol = this.getTradingCommission;
+  /**
+   * alias of {@link getTradingCommission}
+   */
+  getTradingCommissionBySymbol = this.getTradingCommission;
+
+  // WALLET MANAGEMENT
+
+  /**
+   * alias of {@link getWalletBalance}
+   */
+  getWalletBalanceOfCurrency = this.getWalletBalance;
+  /**
+   * alias of {@link getWalletBalance}
+   */
+  getWalletBalanceByCurrency = this.getWalletBalance;
+  /**
+   * alais of {@link getDepositCryptoAddress}
+   */
+  getDepositCryptoAddressByCurrency = this.getDepositCryptoAddress;
+  /**
+   * alias of {@link getDepositCryptoAddress}
+   */
+  getDepositCryptoAddressOfCurrency = this.getDepositCryptoAddress;
+
+
+
   //////////////////
   // PUBLIC CALLS //
   //////////////////

lib/websocket/marketDataClient.ts

@@ -206,7 +206,7 @@ export class MarketDataClient extends WSClientBase {
    *
    * @param {function} callback a function that recieves notifications as a dict of candles indexed by symbol, and the type of notification (either SNAPSHOT or UPDATE)
    * @param {function} params.targetCurrency Target currency for conversion
-   * @param {PERIOD} params.period A valid tick interval. 'M1' (one minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one hour), 'H4', 'D1' (one day), 'D7', '1M' (one month). Default is 'M30'
+   * @param {PERIOD} params.period A valid tick interval. 'M1' (one minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one hour), 'H4', 'D1' (one day), 'D7', '1M' (one month).
    * @param {string[]} params.symbols A list of symbol ids
    * @param {number} [params.limit] Optional. Number of historical entries returned in the first feed. Min is 0. Max is 1000. Default is 0
    * @return A promise that resolves when subscribed with a list of the successfully subscribed symbols

lib/websocket/tradingClient.ts

@@ -229,6 +229,11 @@ export class TradingClient extends AuthClient {
     return this.makeRequest<Balance>({ method: "spot_balance", params: { currency } });
   }
 
+  /**
+   * alias of {@link getSpotTradingBalance}
+   */
+  getSpotTradingBalanceOfCurrency = this.getSpotTradingBalance;
+
   /**
    * Get the personal trading fee rates for all symbols
    *
@@ -254,6 +259,15 @@ export class TradingClient extends AuthClient {
     return fromSnakeCaseToCamelCase(commission)
   }
 
+  /**
+   * alias of {@link getSpotFee}
+   */
+  getSpotFeeOfSymbol = this.getSpotFee;
+  /**
+   * alias of {@link getSpotFee}
+   */
+  getSpotFeeBySymbol = this.getSpotFee;
+
   ///////////////////
   // subscriptions //
   ///////////////////

lib/websocket/walletClient.ts

@@ -66,6 +66,15 @@ export class WalletClient extends AuthClient {
     return { available: response.available, reserved: response.reserved, currency: currency };
   }
 
+  /**
+   * alias of {@link getWalletBalance}
+   */
+  getWalletBalanceOfCurrency = this.getWalletBalance;
+  /**
+   * alias of {@link getWalletBalance}
+   */
+  getWalletBalanceByCurrency = this.getWalletBalance;
+
   /**
    * Get the transaction history of the account
    *

test/rest/spotTrading.test.ts

@@ -13,7 +13,7 @@ import {
   goodTradingCommission,
   listSize,
 } from "../testHelpers";
-const keys = require("../../keys.json");
+const keys = require("../../../../keys.json");
 
 describe("spot trading", () => {
   let client = new Client(keys.apiKey, keys.apiSecret);

test/rest/spotTradingHistory.test.ts

@@ -1,8 +1,7 @@
 import assert from "assert";
 import { Client } from "../../lib";
 import { goodList, goodOrder, goodTrade } from "../testHelpers";
-const keys = require("../../keys.json");
-
+const keys = require("../../../../keys.json");
 import "mocha";
 
 describe("spot trading history", () => {

test/rest/walletManagement.test.ts

@@ -12,7 +12,7 @@ import {
   goodTransaction,
 } from "../testHelpers";
 import { Address } from "../../lib/models";
-const keys = require("../../keys.json");
+const keys = require("../../../../keys.json");
 
 describe("wallet management", () => {
   let client = new Client(keys.apiKey, keys.apiSecret);

test/websocket/marketData.test.ts

@@ -54,7 +54,7 @@ describe("websocket market data client", function () {
   });
 
 
-  describe.only("subscribe to converted candles", function () {
+  describe("subscribe to converted candles", function () {
     it("gets a feed of candles", async function () {
       this.timeout(0);
       await wsclient.connect();

test/websocket/trading.test.ts

@@ -1,4 +1,5 @@
-const keys = require("../../keys.json");
+
+const keys = require("../../../../keys.json");
 import { expect } from "chai";
 import "mocha";
 import { WSTradingClient } from "../../lib";

test/websocket/tradingSubscriptions.test.ts

@@ -1,4 +1,5 @@
-const keys = require("../../keys.json");
+
+const keys = require("../../../../keys.json");
 import { expect } from "chai";
 import { WSTradingClient } from "../../lib";
 import { SUBSCRIPTION_MODE } from "../../lib/constants";