From 1d5099d88a921663e608f82ace37ce4adae8e8b9 Mon Sep 17 00:00:00 2001 From: Cris Mihalache Date: Tue, 25 Jun 2024 10:31:39 +0200 Subject: [PATCH] fix: add missing JSDoc dev dep --- CHANGELOG | 3 + docs/AccountSummary.html | 4 +- docs/Alert.html | 4 +- docs/AuthPermission.html | 4 +- docs/BalanceInfo.html | 4 +- docs/Candle.html | 4 +- docs/ChangeLog.html | 4 +- docs/CoreSettings.html | 4 +- docs/Currency.html | 4 +- docs/FundingCredit.html | 4 +- docs/FundingInfo.html | 162 +- docs/FundingLoan.html | 4 +- docs/FundingOffer.html | 320 +-- docs/FundingTicker.html | 278 +-- docs/FundingTickerHist.html | 278 +-- docs/FundingTrade.html | 162 +- docs/Invoice.html | 160 +- docs/LedgerEntry.html | 4 +- docs/Liquidations.html | 160 +- docs/Login.html | 4 +- docs/MarginInfo.html | 162 +- docs/Model.html | 428 ++-- docs/Movement.html | 4 +- docs/MovementInfo.html | 4 +- docs/Notification.html | 4 +- docs/Order.html | 1872 ++++++++--------- docs/OrderBook.html | 992 ++++----- docs/Position.html | 270 +-- docs/PublicPulseProfile.html | 160 +- docs/PublicTrade.html | 160 +- docs/PulseMessage.html | 274 +-- docs/StatusMessagesDeriv.html | 4 +- docs/SymbolDetails.html | 4 +- docs/Trade.html | 160 +- docs/TradingTicker.html | 278 +-- docs/TradingTickerHist.html | 278 +-- docs/TransactionFee.html | 4 +- docs/UserInfo.html | 4 +- docs/Wallet.html | 4 +- docs/WalletHist.html | 4 +- docs/WeightedAverages.html | 4 +- docs/account_summary.js.html | 4 +- docs/alert.js.html | 4 +- docs/auth_permission.js.html | 4 +- docs/balance_info.js.html | 4 +- docs/candle.js.html | 4 +- docs/change_log.js.html | 4 +- docs/core_settings.js.html | 4 +- docs/currency.js.html | 4 +- docs/funding_credit.js.html | 4 +- docs/funding_info.js.html | 4 +- docs/funding_loan.js.html | 4 +- docs/funding_offer.js.html | 4 +- docs/funding_ticker.js.html | 4 +- docs/funding_ticker_hist.js.html | 4 +- docs/funding_trade.js.html | 4 +- docs/global.html | 4 +- docs/index.html | 4 +- docs/invoice.js.html | 4 +- docs/ledger_entry.js.html | 4 +- docs/liquidations.js.html | 4 +- docs/login.js.html | 4 +- docs/margin_info.js.html | 4 +- docs/model.js.html | 4 +- docs/movement.js.html | 4 +- docs/movement_info.js.html | 4 +- docs/notification.js.html | 4 +- docs/order.js.html | 4 +- docs/order_book.js.html | 4 +- docs/position.js.html | 4 +- docs/public_pulse_profile.js.html | 4 +- docs/public_trade.js.html | 4 +- docs/pulse_message.js.html | 4 +- docs/status_messages_deriv.js.html | 4 +- docs/symbol_details.js.html | 4 +- docs/trade.js.html | 4 +- docs/trading_ticker.js.html | 4 +- docs/trading_ticker_hist.js.html | 4 +- docs/transaction_fee.js.html | 4 +- docs/user_info.js.html | 4 +- ...assign_from_collection_or_instance.js.html | 4 +- docs/util_is_collection.js.html | 4 +- docs/validators_amount.js.html | 4 +- docs/validators_array.js.html | 4 +- docs/validators_bool.js.html | 4 +- docs/validators_currency.js.html | 4 +- docs/validators_date.js.html | 4 +- docs/validators_number.js.html | 4 +- docs/validators_object.js.html | 4 +- docs/validators_price.js.html | 4 +- docs/validators_string.js.html | 4 +- docs/validators_symbol.js.html | 4 +- docs/wallet.js.html | 4 +- docs/wallet_hist.js.html | 4 +- docs/weighted_averages.js.html | 4 +- package.json | 3 +- 96 files changed, 3434 insertions(+), 3430 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index cdbe5ff..1cdf2ec 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,6 @@ +# 1.8.2 +- fix: add missing JSDoc dev dep + # 1.8.1 - fix: Add extra Weighted Averages fields for trades timestamps diff --git a/docs/AccountSummary.html b/docs/AccountSummary.html index 201f1b9..f1a300e 100644 --- a/docs/AccountSummary.html +++ b/docs/AccountSummary.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -894,7 +894,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/Alert.html b/docs/Alert.html index 25f5403..8a27e13 100644 --- a/docs/Alert.html +++ b/docs/Alert.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -688,7 +688,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/AuthPermission.html b/docs/AuthPermission.html index 8c461aa..b9ca29e 100644 --- a/docs/AuthPermission.html +++ b/docs/AuthPermission.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -664,7 +664,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/BalanceInfo.html b/docs/BalanceInfo.html index 7f08f0a..5609224 100644 --- a/docs/BalanceInfo.html +++ b/docs/BalanceInfo.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -642,7 +642,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/Candle.html b/docs/Candle.html index d7213cc..a641c99 100644 --- a/docs/Candle.html +++ b/docs/Candle.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -733,7 +733,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/ChangeLog.html b/docs/ChangeLog.html index 224d577..675eb89 100644 --- a/docs/ChangeLog.html +++ b/docs/ChangeLog.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -687,7 +687,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/CoreSettings.html b/docs/CoreSettings.html index b5c61fc..a9de4b9 100644 --- a/docs/CoreSettings.html +++ b/docs/CoreSettings.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -664,7 +664,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/Currency.html b/docs/Currency.html index 2e98b14..3c4eef6 100644 --- a/docs/Currency.html +++ b/docs/Currency.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -710,7 +710,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/FundingCredit.html b/docs/FundingCredit.html index c336e74..fc53bff 100644 --- a/docs/FundingCredit.html +++ b/docs/FundingCredit.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -1021,7 +1021,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/FundingInfo.html b/docs/FundingInfo.html index f33ac65..4f026ac 100644 --- a/docs/FundingInfo.html +++ b/docs/FundingInfo.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -231,7 +231,7 @@

Methods

-

(static) unserialize(data) → {object}

+

serialize() → {Array}

@@ -243,7 +243,7 @@

(static)
Source:
@@ -283,8 +283,7 @@

(static)
-

TODO: Figure out a better object key for 'payload', as we need to support -both arrays and POJOs

+

Return an array representation of this model

@@ -297,64 +296,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Array> -| - -Array - - - -

data to convert to POJO

- - @@ -373,7 +314,7 @@
Returns:
-

pojo

+

arr

@@ -384,7 +325,7 @@
Returns:
-object +Array
@@ -399,7 +340,7 @@
Returns:
-

(static) validate(data) → {string}

+

(static) unserialize(data) → {object}

@@ -411,7 +352,7 @@

(static) val
Source:
@@ -451,7 +392,8 @@

(static) val
-

Validates a given funding info instance

+

TODO: Figure out a better object key for 'payload', as we need to support +both arrays and POJOs

@@ -501,10 +443,7 @@

Parameters:
object | -Array.<FundingInfo> -| - -FundingInfo +Array.<Array> | Array @@ -517,7 +456,7 @@
Parameters:
-

instance to validate

+

data to convert to POJO

@@ -543,7 +482,7 @@
Returns:
-

error - null if instance is valid

+

pojo

@@ -554,7 +493,7 @@
Returns:
-string +object
@@ -569,7 +508,7 @@
Returns:
-

serialize() → {Array}

+

(static) validate(data) → {string}

@@ -581,7 +520,7 @@

serializeSource:
@@ -621,7 +560,7 @@

serialize -

Return an array representation of this model

+

Validates a given funding info instance

@@ -634,6 +573,67 @@

serializeParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| + +object +| + +Array.<FundingInfo> +| + +FundingInfo +| + +Array + + + +

instance to validate

+ + @@ -652,7 +652,7 @@
Returns:
-

arr

+

error - null if instance is valid

@@ -663,7 +663,7 @@
Returns:
-Array +string
@@ -693,7 +693,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/FundingLoan.html b/docs/FundingLoan.html index 8dd7072..3302a08 100644 --- a/docs/FundingLoan.html +++ b/docs/FundingLoan.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -998,7 +998,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/FundingOffer.html b/docs/FundingOffer.html index 015e465..7bf7079 100644 --- a/docs/FundingOffer.html +++ b/docs/FundingOffer.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -645,7 +645,7 @@

Methods

-

(static) unserialize(data) → {object}

+

(async) cancel(apiInterface) → {Promise}

@@ -657,7 +657,7 @@

(static)
Source:
@@ -696,6 +696,10 @@

(static) +
+

Cancel the funding offer

+
+ @@ -731,22 +735,13 @@

Parameters:
- data + apiInterface -Array.<object> -| - -object -| - -Array.<Array> -| - -Array +RESTv2 @@ -756,7 +751,7 @@
Parameters:
-

data to convert to POJO

+

optional rest instance

@@ -782,7 +777,7 @@
Returns:
-

pojo

+

p

@@ -793,7 +788,7 @@
Returns:
-object +Promise
@@ -808,7 +803,7 @@
Returns:
-

(static) validate(data) → {string}

+

(async) close(apiInterface) → {Promise}

@@ -820,7 +815,7 @@

(static) val
Source:
@@ -860,7 +855,7 @@

(static) val
-

Validates a given funding offer instance

+

Close the funding offer

@@ -898,25 +893,13 @@

Parameters:
- data + apiInterface -Array.<object> -| - -object -| - -Array.<FundingOffer> -| - -FundingOffer -| - -Array +RESTv2 @@ -926,7 +909,7 @@
Parameters:
-

instance to validate

+

optional rest instance

@@ -952,7 +935,7 @@
Returns:
-

error - null if instance is valid

+

p

@@ -963,7 +946,7 @@
Returns:
-string +Promise
@@ -978,7 +961,7 @@
Returns:
-

(async) cancel(apiInterface) → {Promise}

+

(async) submit(apiInterface) → {Promise}

@@ -990,7 +973,7 @@

(async) cancel<
Source:
@@ -1030,7 +1013,7 @@

(async) cancel<
-

Cancel the funding offer

+

Submit the funding offer

@@ -1136,7 +1119,7 @@

Returns:
-

(async) close(apiInterface) → {Promise}

+

toNewOfferPacket() → {object}

@@ -1148,7 +1131,7 @@

(async) closeSource:
@@ -1188,7 +1171,8 @@

(async) close -

Close the funding offer

+

Creates an order map that can be used in either the websocket on +command or a rest request body

@@ -1201,55 +1185,6 @@

(async) closeParameters:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
apiInterface - - -RESTv2 - - - -

optional rest instance

- - @@ -1268,7 +1203,7 @@
Returns:
-

p

+

on

@@ -1279,7 +1214,7 @@
Returns:
-Promise +object
@@ -1294,7 +1229,7 @@
Returns:
-

(async) submit(apiInterface) → {Promise}

+

toString() → {string}

@@ -1306,7 +1241,7 @@

(async) submit<
Source:
@@ -1346,7 +1281,7 @@

(async) submit<
-

Submit the funding offer

+

Returns a string representation of the position

@@ -1359,55 +1294,6 @@

(async) submit< -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
apiInterface - - -RESTv2 - - - -

optional rest instance

- - @@ -1426,7 +1312,7 @@
Returns:
-

p

+

desc

@@ -1437,7 +1323,7 @@
Returns:
-Promise +string
@@ -1452,7 +1338,7 @@
Returns:
-

toNewOfferPacket() → {object}

+

(static) unserialize(data) → {object}

@@ -1464,7 +1350,7 @@

toNew
Source:
@@ -1503,10 +1389,6 @@

toNew -
-

Creates an order map that can be used in either the websocket on -command or a rest request body

-
@@ -1517,6 +1399,63 @@

toNew +

Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| + +object +| + +Array.<Array> +| + +Array + + + +

data to convert to POJO

+ @@ -1536,7 +1475,7 @@
Returns:
-

on

+

pojo

@@ -1562,7 +1501,7 @@
Returns:
-

toString() → {string}

+

(static) validate(data) → {string}

@@ -1574,7 +1513,7 @@

toStringSource:
@@ -1614,7 +1553,7 @@

toString -

Returns a string representation of the position

+

Validates a given funding offer instance

@@ -1627,6 +1566,67 @@

toStringParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| + +object +| + +Array.<FundingOffer> +| + +FundingOffer +| + +Array + + + +

instance to validate

+ + @@ -1645,7 +1645,7 @@
Returns:
-

desc

+

error - null if instance is valid

@@ -1686,7 +1686,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/FundingTicker.html b/docs/FundingTicker.html index 97f592b..f31d9cb 100644 --- a/docs/FundingTicker.html +++ b/docs/FundingTicker.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -572,7 +572,7 @@

Methods

-

(static) unserialize(data) → {object}

+

base() → {string}

@@ -584,7 +584,7 @@

(static)
Source:
@@ -623,6 +623,9 @@

(static) +
+

Get the base currency for the ticker.

+
@@ -633,63 +636,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Array> -| - -Array - - - -

data to convert to POJO

- @@ -709,7 +655,7 @@
Returns:
-

pojo

+

baseCurrency

@@ -720,7 +666,7 @@
Returns:
-object +string
@@ -735,7 +681,7 @@
Returns:
-

(static) validate(data) → {string}

+

quote() → {string}

@@ -747,7 +693,7 @@

(static) val
Source:
@@ -787,7 +733,7 @@

(static) val
-

Validates a given funding ticker instance

+

Get the quote currency for the ticker.

@@ -800,67 +746,6 @@

(static) val -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<FundingTicker> -| - -FundingTicker -| - -Array - - - -

instance to validate

- - @@ -879,7 +764,7 @@
Returns:
-

error - null if instance is valid

+

quoteCurrency

@@ -905,7 +790,7 @@
Returns:
-

base() → {string}

+

(static) unserialize(data) → {object}

@@ -917,7 +802,7 @@

baseSource:
@@ -956,9 +841,6 @@

base -

Get the base currency for the ticker.

-

@@ -969,6 +851,63 @@

base + + + + Name + + + Type + + + + + + Description + + + + + + + + + data + + + + + +Array.<object> +| + +object +| + +Array.<Array> +| + +Array + + + + + + + + + +

data to convert to POJO

+ + + + + + @@ -988,7 +927,7 @@
Returns:
-

baseCurrency

+

pojo

@@ -999,7 +938,7 @@
Returns:
-string +object
@@ -1014,7 +953,7 @@
Returns:
-

quote() → {string}

+

(static) validate(data) → {string}

@@ -1026,7 +965,7 @@

quoteSource:
@@ -1066,7 +1005,7 @@

quote -

Get the quote currency for the ticker.

+

Validates a given funding ticker instance

@@ -1079,6 +1018,67 @@

quoteParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| + +object +| + +Array.<FundingTicker> +| + +FundingTicker +| + +Array + + + +

instance to validate

+ + @@ -1097,7 +1097,7 @@
Returns:
-

quoteCurrency

+

error - null if instance is valid

@@ -1138,7 +1138,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/FundingTickerHist.html b/docs/FundingTickerHist.html index 8c905ac..5f9971d 100644 --- a/docs/FundingTickerHist.html +++ b/docs/FundingTickerHist.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -362,7 +362,7 @@

Methods

-

(static) unserialize(data) → {object}

+

base() → {string}

@@ -374,7 +374,7 @@

(static)
Source:
@@ -413,6 +413,9 @@

(static) +
+

Get the base currency for the historical ticker.

+
@@ -423,63 +426,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Array> -| - -Array - - - -

data to convert to POJO

- @@ -499,7 +445,7 @@
Returns:
-

pojo

+

baseCurrency

@@ -510,7 +456,7 @@
Returns:
-object +string
@@ -525,7 +471,7 @@
Returns:
-

(static) validate(data) → {string}

+

quote() → {string}

@@ -537,7 +483,7 @@

(static) val
Source:
@@ -577,7 +523,7 @@

(static) val
-

Validates a given historical funding ticker instance.

+

Get the quote currency for the historical ticker.

@@ -590,67 +536,6 @@

(static) val -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<FundingTickerHist> -| - -FundingTickerHist -| - -Array - - - -

instance to validate

- - @@ -669,7 +554,7 @@
Returns:
-

error - null if instance is valid

+

quoteCurrency

@@ -695,7 +580,7 @@
Returns:
-

base() → {string}

+

(static) unserialize(data) → {object}

@@ -707,7 +592,7 @@

baseSource:
@@ -746,9 +631,6 @@

base -

Get the base currency for the historical ticker.

-

@@ -759,6 +641,63 @@

base + + + + Name + + + Type + + + + + + Description + + + + + + + + + data + + + + + +Array.<object> +| + +object +| + +Array.<Array> +| + +Array + + + + + + + + + +

data to convert to POJO

+ + + + + + @@ -778,7 +717,7 @@
Returns:
-

baseCurrency

+

pojo

@@ -789,7 +728,7 @@
Returns:
-string +object
@@ -804,7 +743,7 @@
Returns:
-

quote() → {string}

+

(static) validate(data) → {string}

@@ -816,7 +755,7 @@

quoteSource:
@@ -856,7 +795,7 @@

quote -

Get the quote currency for the historical ticker.

+

Validates a given historical funding ticker instance.

@@ -869,6 +808,67 @@

quoteParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| + +object +| + +Array.<FundingTickerHist> +| + +FundingTickerHist +| + +Array + + + +

instance to validate

+ + @@ -887,7 +887,7 @@
Returns:
-

quoteCurrency

+

error - null if instance is valid

@@ -928,7 +928,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/FundingTrade.html b/docs/FundingTrade.html index 5815f3a..96b1ef4 100644 --- a/docs/FundingTrade.html +++ b/docs/FundingTrade.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -434,7 +434,7 @@

Methods

-

(static) unserialize(data) → {object}

+

toString() → {string}

@@ -446,7 +446,7 @@

(static)
Source:
@@ -485,6 +485,10 @@

(static) +
+

Returns a string representation of the model, containing pertinent +information.

+
@@ -495,63 +499,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Array> -| - -Array - - - -

data to convert to POJO

- @@ -571,7 +518,7 @@
Returns:
-

pojo

+

str

@@ -582,7 +529,7 @@
Returns:
-object +string
@@ -597,7 +544,7 @@
Returns:
-

(static) validate(data) → {string}

+

(static) unserialize(data) → {object}

@@ -609,7 +556,7 @@

(static) val
Source:
@@ -648,10 +595,6 @@

(static) val -
-

Validates a given funding trade instance

-
- @@ -699,10 +642,7 @@

Parameters:
object | -Array.<FundingTrade> -| - -FundingTrade +Array.<Array> | Array @@ -715,7 +655,7 @@
Parameters:
-

instance to validate

+

data to convert to POJO

@@ -741,7 +681,7 @@
Returns:
-

error - null if instance is valid

+

pojo

@@ -752,7 +692,7 @@
Returns:
-string +object
@@ -767,7 +707,7 @@
Returns:
-

toString() → {string}

+

(static) validate(data) → {string}

@@ -779,7 +719,7 @@

toStringSource:
@@ -819,8 +759,7 @@

toString -

Returns a string representation of the model, containing pertinent -information.

+

Validates a given funding trade instance

@@ -833,6 +772,67 @@

toStringParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| + +object +| + +Array.<FundingTrade> +| + +FundingTrade +| + +Array + + + +

instance to validate

+ + @@ -851,7 +851,7 @@
Returns:
-

str

+

error - null if instance is valid

@@ -892,7 +892,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/Invoice.html b/docs/Invoice.html index a917a65..9144ddf 100644 --- a/docs/Invoice.html +++ b/docs/Invoice.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -316,7 +316,7 @@

Methods

-

(static) unserialize(data) → {object}

+

toString() → {string}

@@ -328,7 +328,7 @@

(static)
Source:
@@ -377,64 +377,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Array> -| - -Array - - - -

data to convert to POJO

- - @@ -453,7 +395,7 @@
Returns:
-

pojo

+

str

@@ -464,7 +406,7 @@
Returns:
-object +string
@@ -479,7 +421,7 @@
Returns:
-

(static) validate(data) → {string}

+

(static) unserialize(data) → {object}

@@ -491,7 +433,7 @@

(static) val
Source:
@@ -530,10 +472,6 @@

(static) val -
-

Validates a given invoice instance

-
- @@ -581,10 +519,7 @@

Parameters:
object | -Array.<Invoice> -| - -Invoice +Array.<Array> | Array @@ -597,7 +532,7 @@
Parameters:
-

instance to validate

+

data to convert to POJO

@@ -623,7 +558,7 @@
Returns:
-

error - null if instance is valid

+

pojo

@@ -634,7 +569,7 @@
Returns:
-string +object
@@ -649,7 +584,7 @@
Returns:
-

toString() → {string}

+

(static) validate(data) → {string}

@@ -661,7 +596,7 @@

toStringSource:
@@ -700,14 +635,79 @@

toString +

Validates a given invoice instance

+

+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| +object +| +Array.<Invoice> +| +Invoice +| +Array + +

instance to validate

@@ -728,7 +728,7 @@
Returns:
-

str

+

error - null if instance is valid

@@ -769,7 +769,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/LedgerEntry.html b/docs/LedgerEntry.html index f4ea7ef..7b36ad7 100644 --- a/docs/LedgerEntry.html +++ b/docs/LedgerEntry.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -734,7 +734,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/Liquidations.html b/docs/Liquidations.html index 0d4165d..26fa253 100644 --- a/docs/Liquidations.html +++ b/docs/Liquidations.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -414,7 +414,7 @@

Methods

-

(static) unserialize(data) → {object}

+

toString() → {string}

@@ -426,7 +426,7 @@

(static)
Source:
@@ -475,64 +475,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Array> -| - -Array - - - -

data to convert to POJO

- - @@ -551,7 +493,7 @@
Returns:
-

pojo

+

str

@@ -562,7 +504,7 @@
Returns:
-object +string
@@ -577,7 +519,7 @@
Returns:
-

(static) validate(data) → {string}

+

(static) unserialize(data) → {object}

@@ -589,7 +531,7 @@

(static) val
Source:
@@ -628,10 +570,6 @@

(static) val -
-

Validates a given liquidation instance

-
- @@ -679,10 +617,7 @@

Parameters:
object | -Array.<Liquidations> -| - -Liquidations +Array.<Array> | Array @@ -695,7 +630,7 @@
Parameters:
-

instance to validate

+

data to convert to POJO

@@ -721,7 +656,7 @@
Returns:
-

error - null if instance is valid

+

pojo

@@ -732,7 +667,7 @@
Returns:
-string +object
@@ -747,7 +682,7 @@
Returns:
-

toString() → {string}

+

(static) validate(data) → {string}

@@ -759,7 +694,7 @@

toStringSource:
@@ -798,14 +733,79 @@

toString +

Validates a given liquidation instance

+

+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| +object +| +Array.<Liquidations> +| +Liquidations +| +Array + +

instance to validate

@@ -826,7 +826,7 @@
Returns:
-

str

+

error - null if instance is valid

@@ -867,7 +867,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/Login.html b/docs/Login.html index 6992d46..3ada311 100644 --- a/docs/Login.html +++ b/docs/Login.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -687,7 +687,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/MarginInfo.html b/docs/MarginInfo.html index c002190..63ce5ed 100644 --- a/docs/MarginInfo.html +++ b/docs/MarginInfo.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -231,7 +231,7 @@

Methods

-

(static) unserialize(data) → {object}

+

serialize() → {Array}

@@ -243,7 +243,7 @@

(static)
Source:
@@ -283,8 +283,7 @@

(static)
-

TODO: Figure out a better object key for 'payload', as we need to support -both arrays and POJOs

+

Return an array representation of this model

@@ -297,64 +296,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Array> -| - -Array - - - -

data to convert to POJO

- - @@ -373,7 +314,7 @@
Returns:
-

pojo

+

arr

@@ -384,7 +325,7 @@
Returns:
-object +Array
@@ -399,7 +340,7 @@
Returns:
-

(static) validate(data) → {string}

+

(static) unserialize(data) → {object}

@@ -411,7 +352,7 @@

(static) val
Source:
@@ -451,7 +392,8 @@

(static) val
-

Validates a given margin info instance

+

TODO: Figure out a better object key for 'payload', as we need to support +both arrays and POJOs

@@ -501,10 +443,7 @@

Parameters:
object | -Array.<MarginInfo> -| - -MarginInfo +Array.<Array> | Array @@ -517,7 +456,7 @@
Parameters:
-

instance to validate

+

data to convert to POJO

@@ -543,7 +482,7 @@
Returns:
-

error - null if instance is valid

+

pojo

@@ -554,7 +493,7 @@
Returns:
-string +object
@@ -569,7 +508,7 @@
Returns:
-

serialize() → {Array}

+

(static) validate(data) → {string}

@@ -581,7 +520,7 @@

serializeSource:
@@ -621,7 +560,7 @@

serialize -

Return an array representation of this model

+

Validates a given margin info instance

@@ -634,6 +573,67 @@

serializeParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| + +object +| + +Array.<MarginInfo> +| + +MarginInfo +| + +Array + + + +

instance to validate

+ + @@ -652,7 +652,7 @@
Returns:
-

arr

+

error - null if instance is valid

@@ -663,7 +663,7 @@
Returns:
-Array +string
@@ -693,7 +693,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/Model.html b/docs/Model.html index 295390a..24dee93 100644 --- a/docs/Model.html +++ b/docs/Model.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -351,7 +351,7 @@

Methods

-

(static) unserialize(args) → {object}

+

serialize() → {Array}

@@ -363,7 +363,7 @@

(static)
Source:
@@ -403,8 +403,7 @@

(static)
-

Generic method for converting either an array, object, or model instance to -a POJO.

+

Converts this model to array-format and returns the result

@@ -417,182 +416,113 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
args - - -object - -

arguments

-
Properties
- - - - - - +
Returns:
+ +
+

arr

+
- - - - +
+
+ Type +
+
+Array -
- - - + + + - - - - - - - - +
- + +
Source:
+
+ -
- + - - - - + - + - - - + - + - - + - - - - + - - - - - - - - - -
NameTypeAttributesDescription
data + + - -Array.<object> -| -object -| + -Array +

toJS() → {object}

+ - - 		- - - -

can also be a model instance

fields - - -object + + - - - + - + - -

field definitions, { [index]: key }

boolFields - - -Array.<string> + + + + + + + + +
+

Converts this model to object-format and returns the result

+
- - 		- - <optional>
- - - -

array of boolean field keys, default empty

-
@@ -639,7 +569,7 @@
Returns:
-

(static) validate(args) → {Error|null}

+

(static) unserialize(args) → {object}

@@ -651,7 +581,7 @@

(static) val
Source:
@@ -691,9 +621,8 @@

(static) val
-

Validates either a single model instance or a collection of model instances -against a set of validation functions defined per-key.

-

Returns the first error found.

+

Generic method for converting either an array, object, or model instance to +a POJO.

@@ -805,7 +734,7 @@

Properties
-

model or collection to validate

+

can also be a model instance

@@ -836,38 +765,7 @@
Properties
-

map of fields to array indexes

- - - - - - - validators - - - - - -object - - - - - - - - - - - - - - - - - -

map of field names to validation funcs

+

field definitions, { [index]: key }

@@ -933,7 +831,7 @@
Returns:
-

error - null if instance is valid

+

pojo

@@ -944,10 +842,7 @@
Returns:
-Error -| - -null +object
@@ -962,7 +857,7 @@
Returns:
-

serialize() → {Array}

+

(static) validate(args) → {Error|null}

@@ -974,7 +869,7 @@

serializeSource:
@@ -1014,7 +909,9 @@

serialize -

Converts this model to array-format and returns the result

+

Validates either a single model instance or a collection of model instances +against a set of validation functions defined per-key.

+

Returns the first error found.

@@ -1027,113 +924,213 @@

serializeParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
args + + +object + +

arguments

+
Properties
+ -
Returns:
- + + + + + -
-

arr

-
- + -
-
- Type -
-
-Array +
+ + - - + + + + + + + + - - + + + + - -
Source:
-
- + - + + - + + + + - + - + + + - + - + + - + + + + - + + + + + + + + -
-

Converts this model to object-format and returns the result

-
+ + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
data + +Array.<object> +| - +object +| -

toJS() → {object}

+Array - + + 		+ + -
+ +

model or collection to validate

fields + + +object - - + + + - + - + +

map of fields to array indexes

validators + + +object - - + + + + + + +

map of field names to validation funcs

boolFields + + +Array.<string> + + + + <optional>
+ + + +

array of boolean field keys, default empty

+
@@ -1154,7 +1151,7 @@
Returns:
-

pojo

+

error - null if instance is valid

@@ -1165,7 +1162,10 @@
Returns:
-object +Error +| + +null
@@ -1195,7 +1195,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/Movement.html b/docs/Movement.html index 34d5f40..b6f6e0f 100644 --- a/docs/Movement.html +++ b/docs/Movement.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -848,7 +848,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/MovementInfo.html b/docs/MovementInfo.html index 79e88fd..8a2f327 100644 --- a/docs/MovementInfo.html +++ b/docs/MovementInfo.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -1032,7 +1032,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/Notification.html b/docs/Notification.html index 3a97cbe..84c759a 100644 --- a/docs/Notification.html +++ b/docs/Notification.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -756,7 +756,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/Order.html b/docs/Order.html index 54970a0..2a52ab9 100644 --- a/docs/Order.html +++ b/docs/Order.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -961,7 +961,7 @@

Methods

-

(static) getBaseCurrency(arr) → {string}

+

(async) cancel(apiInterface) → {Promise}

@@ -973,7 +973,7 @@

(static) Source:
@@ -1013,7 +1013,7 @@

(static) -

Get the base currency for an order in WSv2 array format.

+

Cancel the order if open

@@ -1051,13 +1051,16 @@
Parameters:
- arr + apiInterface -Array +WSv2 +| + +Rest2 @@ -1067,7 +1070,7 @@
Parameters:
-

order in ws2 array format

+

optional ws or rest, defaults to internal ws

@@ -1093,7 +1096,7 @@
Returns:
-

currency - base currency from symbol

+

p

@@ -1104,7 +1107,7 @@
Returns:
-string +Promise
@@ -1119,7 +1122,7 @@
Returns:
-

(static) getQuoteCurrency(arr) → {string}

+

cbGID() → {string}

@@ -1131,7 +1134,7 @@

(static) Source:
@@ -1171,7 +1174,8 @@

(static) -

Get the quote currency for an order in WSv2 array format.

+

Return the callback group ID for the order, used to bind listeners on +an API interface.

@@ -1184,55 +1188,6 @@

(static) Parameters:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
arr - - -Array - - - -

order in ws2 array format

- - @@ -1251,7 +1206,7 @@
Returns:
-

currency - quote currency from symbol

+

cbGID

@@ -1277,7 +1232,7 @@
Returns:
-

(static) unserialize(data) → {object}

+

getBaseCurrency() → {string}

@@ -1289,7 +1244,7 @@

(static)
Source:
@@ -1328,6 +1283,9 @@

(static) +
+

Returns the base currency of the order.

+
@@ -1338,63 +1296,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Array> -| - -Array - - - -

data to convert to POJO

- @@ -1414,7 +1315,7 @@
Returns:
-

pojo

+

currency

@@ -1425,7 +1326,7 @@
Returns:
-object +string
@@ -1440,7 +1341,7 @@
Returns:
-

(static) validate(data) → {string}

+

getLastFillAmount() → {number}

@@ -1452,7 +1353,7 @@

(static) val
Source:
@@ -1492,7 +1393,7 @@

(static) val
-

Validates a given order instance

+

Query the amount that was filled on the last order update

@@ -1505,67 +1406,6 @@

(static) val -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Order> -| - -Order -| - -Array - - - -

instance to validate

- - @@ -1584,7 +1424,7 @@
Returns:
-

error - null if instance is valid

+

amount

@@ -1595,7 +1435,7 @@
Returns:
-string +number
@@ -1610,7 +1450,7 @@
Returns:
-

(async) cancel(apiInterface) → {Promise}

+

getNotionalValue() → {number}

@@ -1622,7 +1462,7 @@

(async) cancel<
Source:
@@ -1662,7 +1502,7 @@

(async) cancel<
-

Cancel the order if open

+

Returns the notional value of the order

@@ -1675,77 +1515,25 @@

(async) cancel< -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
apiInterface - - -WSv2 -| -Rest2 - -

optional ws or rest, defaults to internal ws

- - - - - - - - - - - - - - - - -
Returns:
+
Returns:
-

p

+

value

@@ -1756,7 +1544,7 @@
Returns:
-Promise +number
@@ -1771,7 +1559,7 @@
Returns:
-

cbGID() → {string}

+

getQuoteCurrency() → {string}

@@ -1783,7 +1571,7 @@

cbGIDSource:
@@ -1823,8 +1611,7 @@

cbGID -

Return the callback group ID for the order, used to bind listeners on -an API interface.

+

Returns the quote currency of the order.

@@ -1855,7 +1642,7 @@
Returns:
-

cbGID

+

currency

@@ -1881,7 +1668,7 @@
Returns:
-

getBaseCurrency() → {string}

+

includesVariableRates() → {boolean}

@@ -1893,7 +1680,7 @@

getBas
Source:
@@ -1932,10 +1719,6 @@

getBas -
-

Returns the base currency of the order.

-
- @@ -1964,7 +1747,7 @@

Returns:
-

currency

+

includesVR

@@ -1975,7 +1758,7 @@
Returns:
-string +boolean
@@ -1990,7 +1773,7 @@
Returns:
-

getLastFillAmount() → {number}

+

isHidden() → {boolean}

@@ -2002,7 +1785,7 @@

getL
Source:
@@ -2041,10 +1824,6 @@

getL -
-

Query the amount that was filled on the last order update

-
- @@ -2073,7 +1852,7 @@

Returns:
-

amount

+

hidden

@@ -2084,7 +1863,7 @@
Returns:
-number +boolean
@@ -2099,7 +1878,7 @@
Returns:
-

getNotionalValue() → {number}

+

isOCO() → {boolean}

@@ -2111,7 +1890,7 @@

getNo
Source:
@@ -2150,10 +1929,6 @@

getNo -
-

Returns the notional value of the order

-
- @@ -2182,7 +1957,7 @@

Returns:
-

value

+

oco

@@ -2193,7 +1968,7 @@
Returns:
-number +boolean
@@ -2208,7 +1983,7 @@
Returns:
-

getQuoteCurrency() → {string}

+

isPartiallyFilled() → {boolean}

@@ -2220,7 +1995,7 @@

getQu
Source:
@@ -2250,6 +2025,13 @@

getQu + +
See:
+
+
    +
  • Order~resetFilledAmount
    • +
+
@@ -2260,7 +2042,8 @@

getQu
-

Returns the quote currency of the order.

+

Indicates if the order is partially filled, based on the original and +current amounts.

@@ -2291,7 +2074,7 @@

Returns:
-

currency

+

isPartiallyFilled

@@ -2302,7 +2085,7 @@
Returns:
-string +boolean
@@ -2317,7 +2100,7 @@
Returns:
-

includesVariableRates() → {boolean}

+

isPositionClose() → {boolean}

@@ -2329,7 +2112,7 @@

Source:
@@ -2396,7 +2179,7 @@

Returns:
-

includesVR

+

posclose

@@ -2422,7 +2205,7 @@
Returns:
-

isHidden() → {boolean}

+

isPostOnly() → {boolean}

@@ -2434,7 +2217,7 @@

isHiddenSource:
@@ -2501,7 +2284,7 @@
Returns:
-

hidden

+

postonly

@@ -2527,7 +2310,7 @@
Returns:
-

isOCO() → {boolean}

+

isReduceOnly() → {boolean}

@@ -2539,7 +2322,7 @@

isOCOSource:
@@ -2606,7 +2389,7 @@
Returns:
-

oco

+

reduceonly

@@ -2632,7 +2415,7 @@
Returns:
-

isPartiallyFilled() → {boolean}

+

isVisibleOnHit() → {boolean}

@@ -2644,7 +2427,7 @@

isPa
Source:
@@ -2674,13 +2457,6 @@

isPa - -
See:
-
-
    -
  • Order~resetFilledAmount
    • -
-
@@ -2690,11 +2466,6 @@

isPa -
-

Indicates if the order is partially filled, based on the original and -current amounts.

-
- @@ -2723,7 +2494,7 @@

Returns:
-

isPartiallyFilled

+

visibleOnHit

@@ -2749,7 +2520,7 @@
Returns:
-

isPositionClose() → {boolean}

+

modifyFlag(flag, active) → {number}

@@ -2761,7 +2532,7 @@

isPosi
Source:
@@ -2800,6 +2571,9 @@

isPosi +
+

Updates a specific flag

+
@@ -2811,108 +2585,76 @@

isPosi +

Parameters:
+ - - - - - - - - - - - - -
Returns:
- + + + -
-

posclose

-
- - - -
-
- Type -
-
+
-boolean - - - - - - - + - - + -

isPostOnly() → {boolean}

+ + + + + + + + + - + - + - + + - + + + + - + - + - + - + + - - - - - - - - - - - - - - + +
NameTypeDescription
flag + + +number -
- - -
Source:
-
- - - - - - - + +

flag value

active + + +boolean - - + +

active status

@@ -2933,7 +2675,7 @@
Returns:
-

postonly

+

finalFlags

@@ -2944,7 +2686,7 @@
Returns:
-boolean +number
@@ -2959,7 +2701,7 @@
Returns:
-

isReduceOnly() → {boolean}

+

(async) recreate(apiInterface) → {Promise}

@@ -2971,7 +2713,7 @@

isReduceO
Source:
@@ -3010,6 +2752,9 @@

isReduceO +
+

Equivalent to calling cancel() followed by submit()

+
@@ -3021,108 +2766,56 @@

isReduceO +

Parameters:
+ - - - - - - - - - - - - -
Returns:
- + + + -
-

reduceonly

-
- - - -
-
- Type -
-
+
-boolean - - - - - - - + - - - - -

isVisibleOnHit() → {boolean}

- - - - - - -
- - -
Source:
-
- - - - - - - - + - +
+ + + - + + + + - + - + - + - + + - - - - - - - - - - - - - - + +
NameTypeDescription
apiInterface + + +WSv2 +| - +RESTv2 - - + +

optional ws or rest, defaults to internal ws

@@ -3143,7 +2836,7 @@
Returns:
-

visibleOnHit

+

p

@@ -3154,7 +2847,7 @@
Returns:
-boolean +Promise
@@ -3169,7 +2862,7 @@
Returns:
-

modifyFlag(flag, active) → {number}

+

registerListeners(apiInterface)

@@ -3181,7 +2874,7 @@

modifyFlag<
Source:
@@ -3221,7 +2914,7 @@

modifyFlag<
-

Updates a specific flag

+

Registers for updates/persistence on the specified ws2 instance.

@@ -3259,36 +2952,13 @@

Parameters:
- flag - - - - - -number - - - - - - - - - -

flag value

- - - - - - - active + apiInterface -boolean +object @@ -3298,7 +2968,7 @@
Parameters:
-

active status

+

optional, defaults to internal ws

@@ -3320,28 +2990,6 @@
Parameters:
-
Returns:
- - -
-

finalFlags

-
- - - -
-
- Type -
-
- -number - - -
-
- - @@ -3350,7 +2998,7 @@
Returns:
-

(async) recreate(apiInterface) → {Promise}

+

removeListeners(apiInterface)

@@ -3362,7 +3010,7 @@

(async) recre
Source:
@@ -3402,7 +3050,8 @@

(async) recre
-

Equivalent to calling cancel() followed by submit()

+

Removes update listeners from the specified ws2 instance. +Will fail if rest interface is provided.

@@ -3459,7 +3108,7 @@

Parameters:
-

optional ws or rest, defaults to internal ws

+

optional ws defaults to internal ws

@@ -3481,28 +3130,6 @@
Parameters:
-
Returns:
- - -
-

p

-
- - - -
-
- Type -
-
- -Promise - - -
-
- - @@ -3511,7 +3138,7 @@
Returns:
-

registerListeners(apiInterface)

+

resetFilledAmount()

@@ -3523,7 +3150,7 @@

regi
Source:
@@ -3553,6 +3180,15 @@

regi + +
See:
+
+
    +
  • Order~getLastFillAmount
    • + +
  • Order~isPartiallyFilled
    • +
+
@@ -3563,7 +3199,7 @@

regi
-

Registers for updates/persistence on the specified ws2 instance.

+

Resets the last amount, so getLastFillAmount() returns 0

@@ -3576,312 +3212,27 @@

regi -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
apiInterface - - -object - -

optional, defaults to internal ws

+ + - - - - - - - - - - - - - - - - - - - - -

removeListeners(apiInterface)

- - - - - - -
- - -
Source:
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
-

Removes update listeners from the specified ws2 instance. -Will fail if rest interface is provided.

-
- - - - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
apiInterface - - -WSv2 -| - -RESTv2 - - - -

optional ws defaults to internal ws

- - - - - - - - - - - - - - - - - - - - - - - - -

resetFilledAmount()

- - - - - - -
- - -
Source:
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
See:
-
-
    -
  • Order~getLastFillAmount
    • - -
  • Order~isPartiallyFilled
    • -
-
- - - -
- - - - - -
-

Resets the last amount, so getLastFillAmount() returns 0

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

setHidden(v) → {number}

@@ -5346,19 +4697,611 @@
Returns:
object - - + + + + + + + + + + + + +

toPreview() → {object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Returns a POJO that can be used as a preview order in Honey Framework +algorithmic orders.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

preview

+
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + + + + + + + +

toString() → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Returns a string representation of the order

+

TODO: add verbose option to log all order information (TIF, etc)

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

str

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + +

(async) update(changes, apiInterfaceopt) → {Promise}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Send an order update packet to the WS server, and update local state. This +updates the order atomically without changing its position in the queue for +its price level.

+

Rejects with an error if an attempt is made to apply a delta to a missing +amount.

+
+ + + + + + + + + +
Example
+ + 
const ws = new WSv2({ ... })
+
+await ws.open()
+await ws.auth()
+
+const o = new Order({ ... }, ws)
+
+await o.submit()
+await o.update({ price: '2.0' }) // update price
+await o.update({ delta: '18.0' }) // update amount with delta
+
+console.log(o.toString()))  // inspect order
+ + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
changes + + +object + + + + + + + + + +

changeset to apply to this order

apiInterface + + +WSv2 +| + +RESTv2 + + + + + + <optional>
+ + + + + +

optional ws or rest, defaults to internal instance

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

p - resolves on ws2 confirmation or rest response

+
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + +

updateFrom(order)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Updates order information from the provided order.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
order + + +Order + + + +

order to update from

+ + + + + + + + + + + + + + +
Throws:
+ + + +
+ +

Error if the order ID/CID/GID do not match

+ +
+ + + -

toPreview() → {object}

+

(static) getBaseCurrency(arr) → {string}

@@ -5370,7 +5313,7 @@

toPreviewSource:
@@ -5410,8 +5353,7 @@

toPreview -

Returns a POJO that can be used as a preview order in Honey Framework -algorithmic orders.

+

Get the base currency for an order in WSv2 array format.

@@ -5424,6 +5366,55 @@

toPreviewParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
arr + + +Array + + + +

order in ws2 array format

+ + @@ -5442,7 +5433,7 @@
Returns:
-

preview

+

currency - base currency from symbol

@@ -5453,7 +5444,7 @@
Returns:
-object +string
@@ -5468,7 +5459,7 @@
Returns:
-

toString() → {string}

+

(static) getQuoteCurrency(arr) → {string}

@@ -5480,7 +5471,7 @@

toStringSource:
@@ -5520,8 +5511,7 @@

toString -

Returns a string representation of the order

-

TODO: add verbose option to log all order information (TIF, etc)

+

Get the quote currency for an order in WSv2 array format.

@@ -5534,6 +5524,55 @@

toStringParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
arr + + +Array + + + +

order in ws2 array format

+ + @@ -5552,7 +5591,7 @@
Returns:
-

str

+

currency - quote currency from symbol

@@ -5578,7 +5617,7 @@
Returns:
-

(async) update(changes, apiInterfaceopt) → {Promise}

+

(static) unserialize(data) → {object}

@@ -5590,7 +5629,7 @@

(async) update<
Source:
@@ -5629,36 +5668,12 @@

(async) update< -
-

Send an order update packet to the WS server, and update local state. This -updates the order atomically without changing its position in the queue for -its price level.

-

Rejects with an error if an attempt is made to apply a delta to a missing -amount.

-
- - - - - - -

Example
- - 
const ws = new WSv2({ ... })
-
-await ws.open()
-await ws.auth()
 
-const o = new Order({ ... }, ws)
 
-await o.submit()
-await o.update({ price: '2.0' }) // update price
-await o.update({ delta: '18.0' }) // update amount with delta
 
-console.log(o.toString()))  // inspect order
@@ -5676,8 +5691,6 @@
Parameters:
Type - Attributes - @@ -5690,67 +5703,32 @@
Parameters:
- changes + data -object - - - - - - - - - - - - - - - - - -

changeset to apply to this order

- - - +Array.<object> +| - - - apiInterface - +object +| - - - -WSv2 +Array.<Array> | -RESTv2 +Array - - - <optional>
- - - - - - - -

optional ws or rest, defaults to internal instance

+

data to convert to POJO

@@ -5776,7 +5754,7 @@
Returns:
-

p - resolves on ws2 confirmation or rest response

+

pojo

@@ -5787,7 +5765,7 @@
Returns:
-Promise +object
@@ -5802,7 +5780,7 @@
Returns:
-

updateFrom(order)

+

(static) validate(data) → {string}

@@ -5814,7 +5792,7 @@

updateFrom<
Source:
@@ -5854,7 +5832,7 @@

updateFrom<
-

Updates order information from the provided order.

+

Validates a given order instance

@@ -5892,13 +5870,25 @@

Parameters:
- order + data +Array.<object> +| + +object +| + +Array.<Order> +| + Order +| + +Array @@ -5908,7 +5898,7 @@
Parameters:
-

order to update from

+

instance to validate

@@ -5928,20 +5918,30 @@
Parameters:
-
Throws:
+ + +
Returns:
+
+

error - null if instance is valid

+
-
- -

Error if the order ID/CID/GID do not match

- -
- +
+
+ Type +
+
+ +string +
+
+ + @@ -5965,7 +5965,7 @@
Throws:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/OrderBook.html b/docs/OrderBook.html index d93637e..f05bf05 100644 --- a/docs/OrderBook.html +++ b/docs/OrderBook.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -280,7 +280,7 @@

Methods

-

(static) checksumArr(arr, rawopt) → {number}

+

askAmount() → {number}

@@ -292,7 +292,7 @@

(static)
Source:
@@ -331,10 +331,6 @@

(static) -
-

Like checksum(), but for raw array-format order books

-
- @@ -345,110 +341,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
arr - - -Array.<Array> - - - - - - - - - - - -

assumed sorted, [topBid, bid, ..., topAsk, ask, ...]

raw - - -boolean - - - - - - <optional>
- - - - - - 		- - false - -

true for raw 'R0' order books

- - @@ -467,7 +359,7 @@
Returns:
-

cs

+

amount - total sell-side volume

@@ -493,7 +385,7 @@
Returns:
-

(static) unserialize(arr, rawopt) → {object}

+

bidAmount() → {number}

@@ -505,7 +397,7 @@

(static)
Source:
@@ -544,126 +436,14 @@

(static) -
-

Converts an array order book entry or snapshot to an object, with 'price', -'count', and 'amount' keys on entries

-
- - - - - -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
arr - - -Array.<number> -| - -Array.<Array.<number>> - - - - - - - - - - - -

array format order book

raw - - -boolean - - - - - - <optional>
- - - - - - 		- - false - -

true for raw 'R0' order books

@@ -684,7 +464,7 @@
Returns:
-

ob - either a map w/ bids & asks, or single entry object

+

amount - total buy-side volume

@@ -695,7 +475,7 @@
Returns:
-object +number
@@ -710,7 +490,7 @@
Returns:
-

(static) updateArrayOBWith(ob, entry, rawopt) → {boolean}

+

checksum() → {number}

@@ -722,7 +502,7 @@

(static) <
Source:
@@ -752,6 +532,13 @@

(static) < + +
See:
+
+ +
@@ -762,7 +549,8 @@

(static) <
-

Modifies an array-format OB in place with an update entry. Maintains sort

+

Generates a crc-32 checksum of our current state. The checksum'ed string +itself is a concatenated list of the top 25 bids & asks, alternating.

@@ -775,145 +563,6 @@

(static) < -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
ob - - -Array.<Array.<number>> - - - - - - - - - - - -

array-format order book

entry - - -Array.<number> - - - - - - - - - - - -

price level to update with

raw - - -boolean - - - - - - <optional>
- - - - - - 		- - false - -

true for raw 'R0' order books

- - @@ -932,7 +581,7 @@
Returns:
-

success - false if entry doesn't match OB

+

cs

@@ -943,7 +592,7 @@
Returns:
-boolean +number
@@ -958,7 +607,7 @@
Returns:
-

askAmount() → {number}

+

getEntry(price) → {object}

@@ -970,7 +619,7 @@

askAmountSource:
@@ -1019,6 +668,55 @@

askAmountParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
price + + +number + + + +

price level to fetch

+ + @@ -1037,7 +735,7 @@
Returns:
-

amount - total sell-side volume

+

entry - unserialized, null if not found

@@ -1048,7 +746,7 @@
Returns:
-number +object
@@ -1063,7 +761,7 @@
Returns:
-

bidAmount() → {number}

+

midPrice() → {number}

@@ -1075,7 +773,7 @@

bidAmountSource:
@@ -1142,7 +840,7 @@
Returns:
-

amount - total buy-side volume

+

price

@@ -1168,7 +866,7 @@
Returns:
-

checksum() → {number}

+

spread() → {number}

@@ -1180,7 +878,7 @@

checksumSource:
@@ -1210,13 +908,6 @@

checksumSee: -
- -
@@ -1226,11 +917,6 @@

checksum -

Generates a crc-32 checksum of our current state. The checksum'ed string -itself is a concatenated list of the top 25 bids & asks, alternating.

-

- @@ -1259,7 +945,7 @@
Returns:
-

cs

+

spread - top bid/ask difference

@@ -1285,7 +971,7 @@
Returns:
-

getEntry(price) → {object}

+

toJS() → {object}

@@ -1297,7 +983,7 @@

getEntrySource:
@@ -1346,55 +1032,6 @@

getEntryParameters:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
price - - -number - - - -

price level to fetch

- - @@ -1413,7 +1050,7 @@
Returns:
-

entry - unserialized, null if not found

+

pojo

@@ -1439,7 +1076,7 @@
Returns:
-

midPrice() → {number}

+

topAsk() → {number}

@@ -1451,7 +1088,7 @@

midPriceSource:
@@ -1518,7 +1155,7 @@
Returns:
-

price

+

topAsk - may be null

@@ -1544,7 +1181,7 @@
Returns:
-

spread() → {number}

+

topAskLevel() → {number}

@@ -1556,7 +1193,7 @@

spreadSource:
@@ -1623,7 +1260,7 @@
Returns:
-

spread - top bid/ask difference

+

topAskLevel - may be null

@@ -1649,7 +1286,7 @@
Returns:
-

toJS() → {object}

+

topBid() → {number}

@@ -1661,7 +1298,7 @@

toJSSource:
@@ -1728,7 +1365,7 @@
Returns:
-

pojo

+

topBid - may be null

@@ -1739,7 +1376,7 @@
Returns:
-object +number
@@ -1754,7 +1391,7 @@
Returns:
-

topAsk() → {number}

+

topBidLevel() → {number}

@@ -1766,7 +1403,7 @@

topAskSource:
@@ -1833,7 +1470,7 @@
Returns:
-

topAsk - may be null

+

topBidLevel - may be null

@@ -1859,7 +1496,7 @@
Returns:
-

topAskLevel() → {number}

+

updateWith(entry) → {boolean}

@@ -1871,7 +1508,7 @@

topAskLeve
Source:
@@ -1910,14 +1547,68 @@

topAskLeve +
+

Integrate an update packet (add, update, or remove a price level). Emits an +'update' event on success

+
+ + + + + + + + + + + +

Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
entry + + +Array + +

price level to update with

@@ -1938,7 +1629,7 @@
Returns:
-

topAskLevel - may be null

+

success - false if entry doesn't match OB

@@ -1949,7 +1640,7 @@
Returns:
-number +boolean
@@ -1964,7 +1655,7 @@
Returns:
-

topBid() → {number}

+

volBPSMid(bps) → {number}

@@ -1976,7 +1667,7 @@

topBidSource:
@@ -2015,14 +1706,67 @@

topBid +

Returns the total volume at n basis points from the mid price

+

+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
bps + + +number + +

basis points from mid price

@@ -2043,7 +1787,7 @@
Returns:
-

topBid - may be null

+

vol - total volume

@@ -2069,7 +1813,7 @@
Returns:
-

topBidLevel() → {number}

+

(static) checksumArr(arr, rawopt) → {number}

@@ -2081,7 +1825,7 @@

topBidLeve
Source:
@@ -2097,37 +1841,145 @@

topBidLeve - + + + + + + + + + + + + + + + + + + + + + + + +
+

Like checksum(), but for raw array-format order books

+
+ + + + + + + + + + + +

Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + - + + + + - + - + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
arr + + +Array.<Array> - - + + + - + - - + + + +

assumed sorted, [topBid, bid, ..., topAsk, ask, ...]

raw + + +boolean + + + + <optional>
+ + + + 		+ + false + +

true for raw 'R0' order books

@@ -2148,7 +2000,7 @@
Returns:
-

topBidLevel - may be null

+

cs

@@ -2174,7 +2026,7 @@
Returns:
-

updateWith(entry) → {boolean}

+

(static) unserialize(arr, rawopt) → {object}

@@ -2186,7 +2038,7 @@

updateWith<
Source:
@@ -2226,8 +2078,8 @@

updateWith<
-

Integrate an update packet (add, update, or remove a price level). Emits an -'update' event on success

+

Converts an array order book entry or snapshot to an object, with 'price', +'count', and 'amount' keys on entries

@@ -2253,8 +2105,12 @@

Parameters:
Type + Attributes + + Default + Description @@ -2265,23 +2121,77 @@
Parameters:
- entry + arr -Array +Array.<number> +| + +Array.<Array.<number>> + + + + + + + + + + + + -

price level to update with

+

array format order book

+ + + + + + + raw + + + + + +boolean + + + + + + + + + <optional>
+ + + + + + + + + + + + false + + + + +

true for raw 'R0' order books

@@ -2307,7 +2217,7 @@
Returns:
-

success - false if entry doesn't match OB

+

ob - either a map w/ bids & asks, or single entry object

@@ -2318,7 +2228,7 @@
Returns:
-boolean +object
@@ -2333,7 +2243,7 @@
Returns:
-

volBPSMid(bps) → {number}

+

(static) updateArrayOBWith(ob, entry, rawopt) → {boolean}

@@ -2345,7 +2255,7 @@

volBPSMidSource:
@@ -2385,7 +2295,7 @@

volBPSMid -

Returns the total volume at n basis points from the mid price

+

Modifies an array-format OB in place with an update entry. Maintains sort

@@ -2411,8 +2321,12 @@
Parameters:
Type + Attributes + + Default + Description @@ -2423,23 +2337,109 @@
Parameters:
- bps + ob -number +Array.<Array.<number>> + + + + + + -

basis points from mid price

+ + + + + + +

array-format order book

+ + + + + + + entry + + + + + +Array.<number> + + + + + + + + + + + + + + + + + + + + + +

price level to update with

+ + + + + + + raw + + + + + +boolean + + + + + + + + + <optional>
+ + + + + + + + + + + + false + + + + +

true for raw 'R0' order books

@@ -2465,7 +2465,7 @@
Returns:
-

vol - total volume

+

success - false if entry doesn't match OB

@@ -2476,7 +2476,7 @@
Returns:
-number +boolean
@@ -2506,7 +2506,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/Position.html b/docs/Position.html index 01b7d17..8c01ebc 100644 --- a/docs/Position.html +++ b/docs/Position.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -685,7 +685,7 @@

Methods

-

(static) unserialize(data) → {object}

+

(async) claim(apiInterfaceopt) → {Promise}

@@ -697,7 +697,7 @@

(static)
Source:
@@ -736,6 +736,10 @@

(static) +
+

Claim the position

+
+ @@ -759,6 +763,8 @@

Parameters:
Type + Attributes + @@ -771,32 +777,33 @@
Parameters:
- data + apiInterface -Array.<object> -| - -object -| - -Array.<Array> -| - -Array +RESTv2 + + + <optional>
+ + + + + + + -

data to convert to POJO

+

defaults to internal interface

@@ -822,7 +829,7 @@
Returns:
-

pojo

+

p

@@ -833,7 +840,7 @@
Returns:
-object +Promise
@@ -848,7 +855,7 @@
Returns:
-

(static) validate(data) → {string}

+

(async) close(apiInterfaceopt) → {Promise}

@@ -860,7 +867,7 @@

(static) val
Source:
@@ -900,7 +907,7 @@

(static) val
-

Validates a given position instance

+

Close the position

@@ -926,6 +933,8 @@

Parameters:
Type + Attributes + @@ -938,35 +947,33 @@
Parameters:
- data + apiInterface -Array.<object> -| - -object -| - -Array.<Position> -| - -Position -| - -Array +RESTv2 + + + <optional>
+ + + + + -

instance to validate

+ + +

defaults to internal interface

@@ -992,7 +999,7 @@
Returns:
-

error - null if instance is valid

+

p

@@ -1003,7 +1010,7 @@
Returns:
-string +Promise
@@ -1018,7 +1025,7 @@
Returns:
-

(async) claim(apiInterfaceopt) → {Promise}

+

orderToClose(apiInterfaceopt) → {Promise}

@@ -1030,7 +1037,7 @@

(async) claimSource:
@@ -1070,7 +1077,7 @@

(async) claim -

Claim the position

+

Generate an order that can be used to close the position.

@@ -1116,6 +1123,9 @@
Parameters:
+WSv2 +| + RESTv2 @@ -1188,7 +1198,7 @@
Returns:
-

(async) close(apiInterfaceopt) → {Promise}

+

toString() → {string}

@@ -1200,7 +1210,7 @@

(async) closeSource:
@@ -1240,7 +1250,7 @@

(async) close -

Close the position

+

Returns a string representation of the position.

@@ -1253,67 +1263,6 @@

(async) closeParameters:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDescription
apiInterface - - -RESTv2 - - - - - - <optional>
- - - - - -

defaults to internal interface

- - @@ -1332,7 +1281,7 @@
Returns:
-

p

+

str

@@ -1343,7 +1292,7 @@
Returns:
-Promise +string
@@ -1358,7 +1307,7 @@
Returns:
-

orderToClose(apiInterfaceopt) → {Promise}

+

(static) unserialize(data) → {object}

@@ -1370,7 +1319,7 @@

orderToCl
Source:
@@ -1409,10 +1358,6 @@

orderToCl -
-

Generate an order that can be used to close the position.

-
- @@ -1436,8 +1381,6 @@

Parameters:
Type - Attributes - @@ -1450,36 +1393,32 @@
Parameters:
- apiInterface + data -WSv2 +Array.<object> | -RESTv2 +object +| +Array.<Array> +| - - +Array - - - - <optional>
- - + + - - -

defaults to internal interface

+

data to convert to POJO

@@ -1505,7 +1444,7 @@
Returns:
-

p

+

pojo

@@ -1516,7 +1455,7 @@
Returns:
-Promise +object
@@ -1531,7 +1470,7 @@
Returns:
-

toString() → {string}

+

(static) validate(data) → {string}

@@ -1543,7 +1482,7 @@

toStringSource:
@@ -1583,7 +1522,7 @@

toString -

Returns a string representation of the position.

+

Validates a given position instance

@@ -1596,6 +1535,67 @@

toStringParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| + +object +| + +Array.<Position> +| + +Position +| + +Array + + + +

instance to validate

+ + @@ -1614,7 +1614,7 @@
Returns:
-

str

+

error - null if instance is valid

@@ -1655,7 +1655,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/PublicPulseProfile.html b/docs/PublicPulseProfile.html index a22402a..c173cb7 100644 --- a/docs/PublicPulseProfile.html +++ b/docs/PublicPulseProfile.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -385,7 +385,7 @@

Methods

-

(static) unserialize(data) → {object}

+

toString() → {string}

@@ -397,7 +397,7 @@

(static)
Source:
@@ -446,64 +446,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Array> -| - -Array - - - -

data to convert to POJO

- - @@ -522,7 +464,7 @@
Returns:
-

pojo

+

str

@@ -533,7 +475,7 @@
Returns:
-object +string
@@ -548,7 +490,7 @@
Returns:
-

(static) validate(data) → {string}

+

(static) unserialize(data) → {object}

@@ -560,7 +502,7 @@

(static) val
Source:
@@ -599,10 +541,6 @@

(static) val -
-

Validates a given public pulse profile instance

-
- @@ -650,10 +588,7 @@

Parameters:
object | -Array.<PublicPulseProfile> -| - -PublicPulseProfile +Array.<Array> | Array @@ -666,7 +601,7 @@
Parameters:
-

instance to validate

+

data to convert to POJO

@@ -692,7 +627,7 @@
Returns:
-

error - null if instance is valid

+

pojo

@@ -703,7 +638,7 @@
Returns:
-string +object
@@ -718,7 +653,7 @@
Returns:
-

toString() → {string}

+

(static) validate(data) → {string}

@@ -730,7 +665,7 @@

toStringSource:
@@ -769,14 +704,79 @@

toString +

Validates a given public pulse profile instance

+

+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| +object +| +Array.<PublicPulseProfile> +| +PublicPulseProfile +| +Array + +

instance to validate

@@ -797,7 +797,7 @@
Returns:
-

str

+

error - null if instance is valid

@@ -838,7 +838,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/PublicTrade.html b/docs/PublicTrade.html index 323ff92..b4fb7b5 100644 --- a/docs/PublicTrade.html +++ b/docs/PublicTrade.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -221,7 +221,7 @@

Methods

-

(static) unserialize(data) → {object}

+

toString() → {string}

@@ -233,7 +233,7 @@

(static)
Source:
@@ -282,64 +282,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Array> -| - -Array - - - -

data to convert to POJO

- - @@ -358,7 +300,7 @@
Returns:
-

pojo

+

str

@@ -369,7 +311,7 @@
Returns:
-object +string
@@ -384,7 +326,7 @@
Returns:
-

(static) validate(data) → {string}

+

(static) unserialize(data) → {object}

@@ -396,7 +338,7 @@

(static) val
Source:
@@ -435,10 +377,6 @@

(static) val -
-

Validates a given public trade instance

-
- @@ -486,10 +424,7 @@

Parameters:
object | -Array.<PublicTrade> -| - -PublicTrade +Array.<Array> | Array @@ -502,7 +437,7 @@
Parameters:
-

instance to validate

+

data to convert to POJO

@@ -528,7 +463,7 @@
Returns:
-

error - null if instance is valid

+

pojo

@@ -539,7 +474,7 @@
Returns:
-string +object
@@ -554,7 +489,7 @@
Returns:
-

toString() → {string}

+

(static) validate(data) → {string}

@@ -566,7 +501,7 @@

toStringSource:
@@ -605,14 +540,79 @@

toString +

Validates a given public trade instance

+

+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| +object +| +Array.<PublicTrade> +| +PublicTrade +| +Array + +

instance to validate

@@ -633,7 +633,7 @@
Returns:
-

str

+

error - null if instance is valid

@@ -674,7 +674,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/PulseMessage.html b/docs/PulseMessage.html index a5ac699..05937d3 100644 --- a/docs/PulseMessage.html +++ b/docs/PulseMessage.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -546,7 +546,7 @@

Methods

-

(static) unserialize(data) → {object}

+

serialize() → {Array}

@@ -558,7 +558,7 @@

(static)
Source:
@@ -597,6 +597,10 @@

(static) +
+

Return an array representation of this model

+
+ @@ -607,62 +611,109 @@

(static) -

Parameters:
- - - - - - - - + + + + + + + + + + + + +
Returns:
+
+

arr

+
+ + +
+
+ Type +
+
+Array -
- - - + + + - - - - - - - +
-
- + +
Source:
+
+ + + + + - -
NameTypeDescription
data + + - -Array.<object> -| -object -| + -Array.<Array> -| +

toString() → {string}

-Array + - -

data to convert to POJO

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -683,7 +734,7 @@
Returns:
-

pojo

+

str

@@ -694,7 +745,7 @@
Returns:
-object +string
@@ -709,7 +760,7 @@
Returns:
-

(static) validate(data) → {string}

+

(static) unserialize(data) → {object}

@@ -721,7 +772,7 @@

(static) val
Source:
@@ -760,10 +811,6 @@

(static) val -
-

Validates a given public pulse profile instance

-
- @@ -811,10 +858,7 @@

Parameters:
object | -Array.<PulseMessage> -| - -PulseMessage +Array.<Array> | Array @@ -827,7 +871,7 @@
Parameters:
-

instance to validate

+

data to convert to POJO

@@ -853,7 +897,7 @@
Returns:
-

error - null if instance is valid

+

pojo

@@ -864,7 +908,7 @@
Returns:
-string +object
@@ -879,7 +923,7 @@
Returns:
-

serialize() → {Array}

+

(static) validate(data) → {string}

@@ -891,7 +935,7 @@

serializeSource:
@@ -931,7 +975,7 @@

serialize -

Return an array representation of this model

+

Validates a given public pulse profile instance

@@ -944,109 +988,65 @@

serializeParameters:

+ - - - - - - - - - - - - - -
Returns:
- + + + -
-

arr

-
- - - -
-
- Type -
-
+
-Array - - - - - - - + - - - - -

toString() → {string}

- - - - - -
- - -
Source:
-
- - - + - +
+ + + - + + + + - + - + - + - + + - - - - - - - - - - - - - - + +
NameTypeDescription
data + + +Array.<object> +| - +object +| - +Array.<PulseMessage> +| - +PulseMessage +| - +Array - - + +

instance to validate

@@ -1067,7 +1067,7 @@
Returns:
-

str

+

error - null if instance is valid

@@ -1108,7 +1108,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/StatusMessagesDeriv.html b/docs/StatusMessagesDeriv.html index b192533..b56b1a5 100644 --- a/docs/StatusMessagesDeriv.html +++ b/docs/StatusMessagesDeriv.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -802,7 +802,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/SymbolDetails.html b/docs/SymbolDetails.html index cd6d18c..ed8fae4 100644 --- a/docs/SymbolDetails.html +++ b/docs/SymbolDetails.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -733,7 +733,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/Trade.html b/docs/Trade.html index fface60..24ab244 100644 --- a/docs/Trade.html +++ b/docs/Trade.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -503,7 +503,7 @@

Methods

-

(static) unserialize(data) → {object}

+

toString() → {string}

@@ -515,7 +515,7 @@

(static)
Source:
@@ -564,64 +564,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Array> -| - -Array - - - -

data to convert to POJO

- - @@ -640,7 +582,7 @@
Returns:
-

pojo

+

str

@@ -651,7 +593,7 @@
Returns:
-object +string
@@ -666,7 +608,7 @@
Returns:
-

(static) validate(data) → {string}

+

(static) unserialize(data) → {object}

@@ -678,7 +620,7 @@

(static) val
Source:
@@ -717,10 +659,6 @@

(static) val -
-

Validates a given trade instance

-
- @@ -768,10 +706,7 @@

Parameters:
object | -Array.<PublicTrade> -| - -PublicTrade +Array.<Array> | Array @@ -784,7 +719,7 @@
Parameters:
-

instance to validate

+

data to convert to POJO

@@ -810,7 +745,7 @@
Returns:
-

error - null if instance is valid

+

pojo

@@ -821,7 +756,7 @@
Returns:
-string +object
@@ -836,7 +771,7 @@
Returns:
-

toString() → {string}

+

(static) validate(data) → {string}

@@ -848,7 +783,7 @@

toStringSource:
@@ -887,14 +822,79 @@

toString +

Validates a given trade instance

+

+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| +object +| +Array.<PublicTrade> +| +PublicTrade +| +Array + +

instance to validate

@@ -915,7 +915,7 @@
Returns:
-

str

+

error - null if instance is valid

@@ -956,7 +956,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/TradingTicker.html b/docs/TradingTicker.html index ba9147a..3ff0436 100644 --- a/docs/TradingTicker.html +++ b/docs/TradingTicker.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -500,7 +500,7 @@

Methods

-

(static) unserialize(data) → {object}

+

base() → {string}

@@ -512,7 +512,7 @@

(static)
Source:
@@ -551,6 +551,9 @@

(static) +
+

Base currency of the ticker

+
@@ -561,63 +564,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Array> -| - -Array - - - -

data to convert to POJO

- @@ -637,7 +583,7 @@
Returns:
-

pojo

+

baseCurrency

@@ -648,7 +594,7 @@
Returns:
-object +string
@@ -663,7 +609,7 @@
Returns:
-

(static) validate(data) → {string}

+

quote() → {string}

@@ -675,7 +621,7 @@

(static) val
Source:
@@ -715,7 +661,7 @@

(static) val
-

Validates a given trading ticker instance

+

Quote currency of the ticker

@@ -728,67 +674,6 @@

(static) val -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<PublicTrade> -| - -PublicTrade -| - -Array - - - -

instance to validate

- - @@ -807,7 +692,7 @@
Returns:
-

error - null if instance is valid

+

quoteCurrency

@@ -833,7 +718,7 @@
Returns:
-

base() → {string}

+

(static) unserialize(data) → {object}

@@ -845,7 +730,7 @@

baseSource:
@@ -884,9 +769,6 @@

base -

Base currency of the ticker

-

@@ -897,6 +779,63 @@

base + + + + Name + + + Type + + + + + + Description + + + + + + + + + data + + + + + +Array.<object> +| + +object +| + +Array.<Array> +| + +Array + + + + + + + + + +

data to convert to POJO

+ + + + + + @@ -916,7 +855,7 @@
Returns:
-

baseCurrency

+

pojo

@@ -927,7 +866,7 @@
Returns:
-string +object
@@ -942,7 +881,7 @@
Returns:
-

quote() → {string}

+

(static) validate(data) → {string}

@@ -954,7 +893,7 @@

quoteSource:
@@ -994,7 +933,7 @@

quote -

Quote currency of the ticker

+

Validates a given trading ticker instance

@@ -1007,6 +946,67 @@

quoteParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| + +object +| + +Array.<PublicTrade> +| + +PublicTrade +| + +Array + + + +

instance to validate

+ + @@ -1025,7 +1025,7 @@
Returns:
-

quoteCurrency

+

error - null if instance is valid

@@ -1066,7 +1066,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/TradingTickerHist.html b/docs/TradingTickerHist.html index 791de6d..ad3dc04 100644 --- a/docs/TradingTickerHist.html +++ b/docs/TradingTickerHist.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -339,7 +339,7 @@

Methods

-

(static) unserialize(data) → {object}

+

base() → {string}

@@ -351,7 +351,7 @@

(static)
Source:
@@ -390,6 +390,9 @@

(static) +
+

Base currency for the ticker.

+
@@ -400,63 +403,6 @@

(static) -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<Array> -| - -Array - - - -

data to convert to POJO

- @@ -476,7 +422,7 @@
Returns:
-

pojo

+

baseCurrency

@@ -487,7 +433,7 @@
Returns:
-object +string
@@ -502,7 +448,7 @@
Returns:
-

(static) validate(data) → {string}

+

quote() → {string}

@@ -514,7 +460,7 @@

(static) val
Source:
@@ -554,7 +500,7 @@

(static) val
-

Validates a given historical trading ticker instance

+

Quote currency for the ticker

@@ -567,67 +513,6 @@

(static) val -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - -Array.<object> -| - -object -| - -Array.<TradingTickerHist> -| - -TradingTickerHist -| - -Array - - - -

instance to validate

- - @@ -646,7 +531,7 @@
Returns:
-

error - null if instance is valid

+

quoteCurrency

@@ -672,7 +557,7 @@
Returns:
-

base() → {string}

+

(static) unserialize(data) → {object}

@@ -684,7 +569,7 @@

baseSource:
@@ -723,9 +608,6 @@

base -

Base currency for the ticker.

-

@@ -736,6 +618,63 @@

base + + + + Name + + + Type + + + + + + Description + + + + + + + + + data + + + + + +Array.<object> +| + +object +| + +Array.<Array> +| + +Array + + + + + + + + + +

data to convert to POJO

+ + + + + + @@ -755,7 +694,7 @@
Returns:
-

baseCurrency

+

pojo

@@ -766,7 +705,7 @@
Returns:
-string +object
@@ -781,7 +720,7 @@
Returns:
-

quote() → {string}

+

(static) validate(data) → {string}

@@ -793,7 +732,7 @@

quoteSource:
@@ -833,7 +772,7 @@

quote -

Quote currency for the ticker

+

Validates a given historical trading ticker instance

@@ -846,6 +785,67 @@

quoteParameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Array.<object> +| + +object +| + +Array.<TradingTickerHist> +| + +TradingTickerHist +| + +Array + + + +

instance to validate

+ + @@ -864,7 +864,7 @@
Returns:
-

quoteCurrency

+

error - null if instance is valid

@@ -905,7 +905,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/TransactionFee.html b/docs/TransactionFee.html index b71ba9a..bd96a6c 100644 --- a/docs/TransactionFee.html +++ b/docs/TransactionFee.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -641,7 +641,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/UserInfo.html b/docs/UserInfo.html index a2980ca..51b44cf 100644 --- a/docs/UserInfo.html +++ b/docs/UserInfo.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -713,7 +713,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/Wallet.html b/docs/Wallet.html index 373c5fd..a617b2f 100644 --- a/docs/Wallet.html +++ b/docs/Wallet.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -710,7 +710,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/WalletHist.html b/docs/WalletHist.html index d18ed47..6239362 100644 --- a/docs/WalletHist.html +++ b/docs/WalletHist.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -733,7 +733,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/WeightedAverages.html b/docs/WeightedAverages.html index 464d34f..b0f1f34 100644 --- a/docs/WeightedAverages.html +++ b/docs/WeightedAverages.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -802,7 +802,7 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/account_summary.js.html b/docs/account_summary.js.html index e82694e..eff1582 100644 --- a/docs/account_summary.js.html +++ b/docs/account_summary.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -152,7 +152,7 @@

account_summary.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/alert.js.html b/docs/alert.js.html index 9a9b0e4..21e76a6 100644 --- a/docs/alert.js.html +++ b/docs/alert.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -114,7 +114,7 @@

alert.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/auth_permission.js.html b/docs/auth_permission.js.html index becef63..5e2db96 100644 --- a/docs/auth_permission.js.html +++ b/docs/auth_permission.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -112,7 +112,7 @@

auth_permission.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/balance_info.js.html b/docs/balance_info.js.html index d6897c7..1be4d50 100644 --- a/docs/balance_info.js.html +++ b/docs/balance_info.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -108,7 +108,7 @@

balance_info.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/candle.js.html b/docs/candle.js.html index 72275ec..fdb605a 100644 --- a/docs/candle.js.html +++ b/docs/candle.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -120,7 +120,7 @@

candle.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/change_log.js.html b/docs/change_log.js.html index 7adb951..1d6c47b 100644 --- a/docs/change_log.js.html +++ b/docs/change_log.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -116,7 +116,7 @@

change_log.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/core_settings.js.html b/docs/core_settings.js.html index 4b71c20..affd849 100644 --- a/docs/core_settings.js.html +++ b/docs/core_settings.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -108,7 +108,7 @@

core_settings.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/currency.js.html b/docs/currency.js.html index 9d09732..1af013f 100644 --- a/docs/currency.js.html +++ b/docs/currency.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -123,7 +123,7 @@

currency.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/funding_credit.js.html b/docs/funding_credit.js.html index 2b96dc2..e416f9d 100644 --- a/docs/funding_credit.js.html +++ b/docs/funding_credit.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -165,7 +165,7 @@

funding_credit.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/funding_info.js.html b/docs/funding_info.js.html index c8f1e2d..aecd19a 100644 --- a/docs/funding_info.js.html +++ b/docs/funding_info.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -146,7 +146,7 @@

funding_info.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/funding_loan.js.html b/docs/funding_loan.js.html index d34ca70..36365ad 100644 --- a/docs/funding_loan.js.html +++ b/docs/funding_loan.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -168,7 +168,7 @@

funding_loan.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/funding_offer.js.html b/docs/funding_offer.js.html index 4c28631..a68feae 100644 --- a/docs/funding_offer.js.html +++ b/docs/funding_offer.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -269,7 +269,7 @@

funding_offer.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/funding_ticker.js.html b/docs/funding_ticker.js.html index cdc0fa5..88997fe 100644 --- a/docs/funding_ticker.js.html +++ b/docs/funding_ticker.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -165,7 +165,7 @@

funding_ticker.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/funding_ticker_hist.js.html b/docs/funding_ticker_hist.js.html index a1baf4f..3290810 100644 --- a/docs/funding_ticker_hist.js.html +++ b/docs/funding_ticker_hist.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -137,7 +137,7 @@

funding_ticker_hist.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/funding_trade.js.html b/docs/funding_trade.js.html index 6ba7bb5..e906d8a 100644 --- a/docs/funding_trade.js.html +++ b/docs/funding_trade.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -154,7 +154,7 @@

funding_trade.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/global.html b/docs/global.html index 9ad59e6..cdccebf 100644 --- a/docs/global.html +++ b/docs/global.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -444,7 +444,7 @@
Properties

- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/index.html b/docs/index.html index e87ea6b..baabe35 100644 --- a/docs/index.html +++ b/docs/index.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -201,7 +201,7 @@

Examples


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/invoice.js.html b/docs/invoice.js.html index 3255187..5df26d0 100644 --- a/docs/invoice.js.html +++ b/docs/invoice.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -126,7 +126,7 @@

invoice.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/ledger_entry.js.html b/docs/ledger_entry.js.html index 30e78fb..1aa1a12 100644 --- a/docs/ledger_entry.js.html +++ b/docs/ledger_entry.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -135,7 +135,7 @@

ledger_entry.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/liquidations.js.html b/docs/liquidations.js.html index 88266f6..980d1bc 100644 --- a/docs/liquidations.js.html +++ b/docs/liquidations.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -146,7 +146,7 @@

liquidations.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/login.js.html b/docs/login.js.html index 92fb9c9..804f9dc 100644 --- a/docs/login.js.html +++ b/docs/login.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -114,7 +114,7 @@

login.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/margin_info.js.html b/docs/margin_info.js.html index d4e7c60..c70c560 100644 --- a/docs/margin_info.js.html +++ b/docs/margin_info.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -180,7 +180,7 @@

margin_info.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/model.js.html b/docs/model.js.html index 6d82ae8..cb6fb7f 100644 --- a/docs/model.js.html +++ b/docs/model.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -242,7 +242,7 @@

model.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/movement.js.html b/docs/movement.js.html index 4032d9b..55f5e11 100644 --- a/docs/movement.js.html +++ b/docs/movement.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -138,7 +138,7 @@

movement.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/movement_info.js.html b/docs/movement_info.js.html index d9b0457..b9da5c4 100644 --- a/docs/movement_info.js.html +++ b/docs/movement_info.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -163,7 +163,7 @@

movement_info.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/notification.js.html b/docs/notification.js.html index 7481080..09ddeac 100644 --- a/docs/notification.js.html +++ b/docs/notification.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -123,7 +123,7 @@

notification.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/order.js.html b/docs/order.js.html index 1b07f72..0326030 100644 --- a/docs/order.js.html +++ b/docs/order.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -833,7 +833,7 @@

order.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/order_book.js.html b/docs/order_book.js.html index c5213f6..6975705 100644 --- a/docs/order_book.js.html +++ b/docs/order_book.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -601,7 +601,7 @@

order_book.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/position.js.html b/docs/position.js.html index f3c6ccc..0d09e72 100644 --- a/docs/position.js.html +++ b/docs/position.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -251,7 +251,7 @@

position.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/public_pulse_profile.js.html b/docs/public_pulse_profile.js.html index 3759164..1b0a22c 100644 --- a/docs/public_pulse_profile.js.html +++ b/docs/public_pulse_profile.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -144,7 +144,7 @@

public_pulse_profile.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/public_trade.js.html b/docs/public_trade.js.html index d588acc..fcb0d61 100644 --- a/docs/public_trade.js.html +++ b/docs/public_trade.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -169,7 +169,7 @@

public_trade.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/pulse_message.js.html b/docs/pulse_message.js.html index 3de29fd..635d83b 100644 --- a/docs/pulse_message.js.html +++ b/docs/pulse_message.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -209,7 +209,7 @@

pulse_message.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/status_messages_deriv.js.html b/docs/status_messages_deriv.js.html index a9d5b89..235f02a 100644 --- a/docs/status_messages_deriv.js.html +++ b/docs/status_messages_deriv.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -130,7 +130,7 @@

status_messages_deriv.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/symbol_details.js.html b/docs/symbol_details.js.html index 8701620..7e3f8f0 100644 --- a/docs/symbol_details.js.html +++ b/docs/symbol_details.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -122,7 +122,7 @@

symbol_details.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/trade.js.html b/docs/trade.js.html index 8c132c5..5adf01a 100644 --- a/docs/trade.js.html +++ b/docs/trade.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -167,7 +167,7 @@

trade.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/trading_ticker.js.html b/docs/trading_ticker.js.html index c28c55b..925043b 100644 --- a/docs/trading_ticker.js.html +++ b/docs/trading_ticker.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -155,7 +155,7 @@

trading_ticker.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/trading_ticker_hist.js.html b/docs/trading_ticker_hist.js.html index 80028aa..bfb8bea 100644 --- a/docs/trading_ticker_hist.js.html +++ b/docs/trading_ticker_hist.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -133,7 +133,7 @@

trading_ticker_hist.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/transaction_fee.js.html b/docs/transaction_fee.js.html index 426d92c..692b604 100644 --- a/docs/transaction_fee.js.html +++ b/docs/transaction_fee.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -110,7 +110,7 @@

transaction_fee.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/user_info.js.html b/docs/user_info.js.html index 799b904..d3461bc 100644 --- a/docs/user_info.js.html +++ b/docs/user_info.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -119,7 +119,7 @@

user_info.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/util_assign_from_collection_or_instance.js.html b/docs/util_assign_from_collection_or_instance.js.html index df7601d..0885d15 100644 --- a/docs/util_assign_from_collection_or_instance.js.html +++ b/docs/util_assign_from_collection_or_instance.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -113,7 +113,7 @@

util/assign_from_collection_or_instance.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/util_is_collection.js.html b/docs/util_is_collection.js.html index eec2041..446b7e5 100644 --- a/docs/util_is_collection.js.html +++ b/docs/util_is_collection.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -72,7 +72,7 @@

util/is_collection.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/validators_amount.js.html b/docs/validators_amount.js.html index 9d8699f..615b030 100644 --- a/docs/validators_amount.js.html +++ b/docs/validators_amount.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -69,7 +69,7 @@

validators/amount.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/validators_array.js.html b/docs/validators_array.js.html index 35ac8b6..eddfa92 100644 --- a/docs/validators_array.js.html +++ b/docs/validators_array.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -70,7 +70,7 @@

validators/array.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/validators_bool.js.html b/docs/validators_bool.js.html index 5b75007..cb37ce9 100644 --- a/docs/validators_bool.js.html +++ b/docs/validators_bool.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -72,7 +72,7 @@

validators/bool.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/validators_currency.js.html b/docs/validators_currency.js.html index 7348f13..6d50f21 100644 --- a/docs/validators_currency.js.html +++ b/docs/validators_currency.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -74,7 +74,7 @@

validators/currency.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/validators_date.js.html b/docs/validators_date.js.html index 0efaddb..e8cc97a 100644 --- a/docs/validators_date.js.html +++ b/docs/validators_date.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -72,7 +72,7 @@

validators/date.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/validators_number.js.html b/docs/validators_number.js.html index 586a68f..326047b 100644 --- a/docs/validators_number.js.html +++ b/docs/validators_number.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -72,7 +72,7 @@

validators/number.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/validators_object.js.html b/docs/validators_object.js.html index 7641b65..5f83607 100644 --- a/docs/validators_object.js.html +++ b/docs/validators_object.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -72,7 +72,7 @@

validators/object.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/validators_price.js.html b/docs/validators_price.js.html index 07b482a..0473225 100644 --- a/docs/validators_price.js.html +++ b/docs/validators_price.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -72,7 +72,7 @@

validators/price.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/validators_string.js.html b/docs/validators_string.js.html index 2d5942f..21a1e7b 100644 --- a/docs/validators_string.js.html +++ b/docs/validators_string.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -75,7 +75,7 @@

validators/string.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/validators_symbol.js.html b/docs/validators_symbol.js.html index 18b35c9..7f09731 100644 --- a/docs/validators_symbol.js.html +++ b/docs/validators_symbol.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -74,7 +74,7 @@

validators/symbol.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/wallet.js.html b/docs/wallet.js.html index 8d8f339..77c5388 100644 --- a/docs/wallet.js.html +++ b/docs/wallet.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -125,7 +125,7 @@

wallet.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/wallet_hist.js.html b/docs/wallet_hist.js.html index 0731e70..1f89f6c 100644 --- a/docs/wallet_hist.js.html +++ b/docs/wallet_hist.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -130,7 +130,7 @@

wallet_hist.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/docs/weighted_averages.js.html b/docs/weighted_averages.js.html index dbdfd50..fd85eca 100644 --- a/docs/weighted_averages.js.html +++ b/docs/weighted_averages.js.html @@ -29,7 +29,7 @@ -

Home

Classes

Global

+

Home

Classes

Global

@@ -128,7 +128,7 @@

weighted_averages.js


- Documentation generated by JSDoc 3.6.11 on Wed Jul 05 2023 11:37:00 GMT+0300 (Eastern European Summer Time) using the docdash theme. + Documentation generated by JSDoc 4.0.3 on Tue Jun 25 2024 10:31:06 GMT+0200 (Central European Summer Time) using the docdash theme.
diff --git a/package.json b/package.json index f25c49b..81dfec6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "bfx-api-node-models", - "version": "1.8.1", + "version": "1.8.2", "description": "Object models for usage with the Bitfinex node API", "engines": { "node": ">=8.3.0" @@ -45,6 +45,7 @@ "chai": "^4.2.0", "docdash": "^1.2.0", "husky": "^4.2.3", + "jsdoc": "^4.0.3", "jsdoc-to-markdown": "^5.0.3", "mocha": "^7.1.0", "nyc": "^15.0.0",