node-kraken-api
Advanced tools
Comparing version 0.4.0 to 0.4.1
@@ -188,3 +188,3 @@ /** | ||
violationMultiplier: 1.1, | ||
authCounterReductionTimeout: 60000, | ||
authCounterReductionTimeout: 300000, | ||
anyPassDecay: 0.95, | ||
@@ -191,0 +191,0 @@ specificPassDecay: 0.95 |
# Changelog | ||
<a name="0.4.1"></a> | ||
## [0.4.1](https://github.com/jpcx/node-kraken-api/tree/0.4.1) (2018-07-21) | ||
| __[Changes since 0.4.0](https://github.com/jpcx/node-kraken-api/compare/0.4.0...0.4.1)__ | [Release Notes](https://github.com/jpcx/node-kraken-api/releases/tag/0.4.1) | [README](https://github.com/jpcx/node-kraken-api/tree/0.4.1/README.md) | | ||
| --- | --- | --- | | ||
| [Source Code (zip)](https://github.com/jpcx/node-kraken-api/archive/0.4.1.zip) | [Source Code (tar.gz)](https://github.com/jpcx/node-kraken-api/archive/0.4.1.tar.gz) | | ||
| --- | --- | | ||
__Bugfixes:__ | ||
+ __API/RateLimits:__ Increased limitConfig.authCounterReductionTimeout to 300000. | ||
<a name="0.4.0"></a> | ||
@@ -4,0 +18,0 @@ |
@@ -9,8 +9,8 @@ # Module: API/Calls/GenRequestData | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Execution settings. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Params) | Object containing call specs. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Execution settings. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Params) | Object containing call specs. | | ||
Source: | ||
* [node-kraken-api/api/calls/genRequestData.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/genRequestData.js), [line 12](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/genRequestData.js#L12) | ||
* [node-kraken-api/api/calls/genRequestData.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/genRequestData.js), [line 12](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/genRequestData.js#L12) | ||
@@ -23,23 +23,23 @@ __Returns:__ | ||
* [API\~Calls~RequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~RequestData) | ||
* [API\~Calls~RequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~RequestData) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -9,8 +9,8 @@ # Module: API/Calls/LoadCall | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Execution settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Execution settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
Source: | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js), [line 242](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js#L242) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js), [line 242](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js#L242) | ||
@@ -23,23 +23,23 @@ __Returns:__ | ||
* [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Call) | ||
* [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Call) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -9,10 +9,10 @@ # Module: API/Calls/SignRequest | ||
| --- | --- | --- | | ||
| `secret` | [Kraken~Secret](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Secret) | Kraken API secret key. | | ||
| `nonce` | [Kraken~Nonce](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Nonce) | Kraken API nonce. | | ||
| `post` | [Kraken~HTTPSRequestPOSTData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~HTTPSRequestPOSTData) | POST data. | | ||
| `path` | [Kraken~Path](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Path) | Path to Kraken Method URL. | | ||
| `secret` | [Kraken~Secret](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Secret) | Kraken API secret key. | | ||
| `nonce` | [Kraken~Nonce](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Nonce) | Kraken API nonce. | | ||
| `post` | [Kraken~HTTPSRequestPOSTData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~HTTPSRequestPOSTData) | POST data. | | ||
| `path` | [Kraken~Path](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Path) | Path to Kraken Method URL. | | ||
Source: | ||
* [node-kraken-api/api/calls/signRequest.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/signRequest.js), [line 11](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/signRequest.js#L11) | ||
* [node-kraken-api/api/calls/signRequest.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/signRequest.js), [line 11](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/signRequest.js#L11) | ||
@@ -25,23 +25,23 @@ __Returns:__ | ||
* [API\~Calls~Signature](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Signature) | ||
* [API\~Calls~Signature](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Signature) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -9,7 +9,7 @@ # Module: API/RateLimits/LoadLimiter | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 159](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L159) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 159](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L159) | ||
@@ -22,23 +22,23 @@ __Returns:__ | ||
* [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Functions) | ||
* [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Functions) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -9,9 +9,9 @@ # Module: API/Syncing/LoadSync | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Call) | Stateful call function. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Call) | Stateful call function. | | ||
Source: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js), [line 280](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js#L280) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js), [line 280](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js#L280) | ||
@@ -24,23 +24,23 @@ __Returns:__ | ||
* [API\~Syncing~Sync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Sync) | ||
* [API\~Syncing~Sync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Sync) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -9,7 +9,7 @@ # Module: node-kraken-api | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | User-defined settings. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | User-defined settings. | | ||
Source: | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/index.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.4.0/index.js#L14) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/index.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.4.1/index.js#L14) | ||
@@ -30,23 +30,23 @@ __Throws:__ | ||
* [API~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md#~Functions) | ||
* [API~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md#~Functions) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -9,7 +9,7 @@ # Module: Settings/ParseSettings | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Current supplied custom settings configuration. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Current supplied custom settings configuration. | | ||
Source: | ||
* [node-kraken-api/settings/parseSettings.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/settings/parseSettings.js), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.4.0/settings/parseSettings.js#L13) | ||
* [node-kraken-api/settings/parseSettings.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/settings/parseSettings.js), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.4.1/settings/parseSettings.js#L13) | ||
@@ -30,23 +30,23 @@ __Throws:__ | ||
* [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | ||
* [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -13,3 +13,3 @@ # Module: Tools/AlphabetizeNested | ||
* [node-kraken-api/tools/alphabetizeNested.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/tools/alphabetizeNested.js), [line 3](https://github.com/jpcx/node-kraken-api/blob/0.4.0/tools/alphabetizeNested.js#L3) | ||
* [node-kraken-api/tools/alphabetizeNested.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/tools/alphabetizeNested.js), [line 3](https://github.com/jpcx/node-kraken-api/blob/0.4.1/tools/alphabetizeNested.js#L3) | ||
@@ -26,19 +26,19 @@ __Returns:__ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
# Module: Tools/ParseNested | ||
Parses objects based on [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md#~ParseNestedConfig). | ||
Parses objects based on [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md#~ParseNestedConfig). | ||
@@ -9,3 +9,3 @@ __Parameters:__ | ||
| --- | --- | --- | | ||
| `config` | [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md#~ParseNestedConfig) | Parse types config. | | ||
| `config` | [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md#~ParseNestedConfig) | Parse types config. | | ||
| `obj` | Object \| Array \| Map \| Set | Object to parse. | | ||
@@ -15,3 +15,3 @@ | ||
* [node-kraken-api/tools/parseNested.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/tools/parseNested.js), [line 12](https://github.com/jpcx/node-kraken-api/blob/0.4.0/tools/parseNested.js#L12) | ||
* [node-kraken-api/tools/parseNested.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/tools/parseNested.js), [line 12](https://github.com/jpcx/node-kraken-api/blob/0.4.1/tools/parseNested.js#L12) | ||
@@ -28,19 +28,19 @@ __Returns:__ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -7,11 +7,11 @@ # API | ||
* [node-kraken-api/api/api.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/api.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/api.jsdoc#L7) | ||
* [node-kraken-api/api/api.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/api.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/api.jsdoc#L7) | ||
## Namespaces | ||
[Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
[Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
[RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
[RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
[Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
[Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
@@ -30,7 +30,7 @@ ## Methods | ||
| --- | --- | --- | | ||
| `limiter` | [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~RateLimiter) | New limiter settings. | | ||
| `limiter` | [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~RateLimiter) | New limiter settings. | | ||
Source: | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/index.js), [line 87](https://github.com/jpcx/node-kraken-api/blob/0.4.0/index.js#L87) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/index.js), [line 87](https://github.com/jpcx/node-kraken-api/blob/0.4.1/index.js#L87) | ||
@@ -63,7 +63,7 @@ __Throws:__ | ||
| --- | --- | --- | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~OTP) | New two-factor password. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~OTP) | New two-factor password. | | ||
Source: | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/index.js), [line 28](https://github.com/jpcx/node-kraken-api/blob/0.4.0/index.js#L28) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/index.js), [line 28](https://github.com/jpcx/node-kraken-api/blob/0.4.1/index.js#L28) | ||
@@ -96,7 +96,7 @@ __Throws:__ | ||
| --- | --- | --- | | ||
| `retryCt` | [API\~Calls~RetryCount](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~RetryCount) | New retryCt. | | ||
| `retryCt` | [API\~Calls~RetryCount](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~RetryCount) | New retryCt. | | ||
Source: | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/index.js), [line 66](https://github.com/jpcx/node-kraken-api/blob/0.4.0/index.js#L66) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/index.js), [line 66](https://github.com/jpcx/node-kraken-api/blob/0.4.1/index.js#L66) | ||
@@ -129,7 +129,7 @@ __Throws:__ | ||
| --- | --- | --- | | ||
| `timeout` | [API\~Calls~Timeout](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Timeout) | New timeout. | | ||
| `timeout` | [API\~Calls~Timeout](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Timeout) | New timeout. | | ||
Source: | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/index.js), [line 45](https://github.com/jpcx/node-kraken-api/blob/0.4.0/index.js#L45) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/index.js), [line 45](https://github.com/jpcx/node-kraken-api/blob/0.4.1/index.js#L45) | ||
@@ -164,8 +164,8 @@ __Throws:__ | ||
| --- | --- | --- | | ||
| `err` | [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~CallError) | Request errors. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~CallData) | Response data. | | ||
| `err` | [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~CallError) | Request errors. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~CallData) | Response data. | | ||
Source: | ||
* [node-kraken-api/api/api.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/api.jsdoc), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/api.jsdoc#L13) | ||
* [node-kraken-api/api/api.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/api.jsdoc), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/api.jsdoc#L13) | ||
@@ -186,32 +186,32 @@ <a name="~Functions"></a> | ||
| --- | --- | --- | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Call) | Call a single method. | | ||
| `sync` | [API\~Syncing~Sync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Sync) | Create a sync instance. | | ||
| `setOTP` | [API~SetOTP](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md#~SetOTP) | Sets new two-factor password. | | ||
| `setTimeout` | [API~SetTimeout](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md#~SetTimeout) | Sets a new timeout. | | ||
| `setRetryCt` | [API~SetRetryCt](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md#~SetRetryCt) | Sets a new retryCt. | | ||
| `setLimiter` | [API~SetLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md#~SetLimiter) | Sets new limiter settings. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Call) | Call a single method. | | ||
| `sync` | [API\~Syncing~Sync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Sync) | Create a sync instance. | | ||
| `setOTP` | [API~SetOTP](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md#~SetOTP) | Sets new two-factor password. | | ||
| `setTimeout` | [API~SetTimeout](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md#~SetTimeout) | Sets a new timeout. | | ||
| `setRetryCt` | [API~SetRetryCt](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md#~SetRetryCt) | Sets a new retryCt. | | ||
| `setLimiter` | [API~SetLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md#~SetLimiter) | Sets new limiter settings. | | ||
Source: | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/index.js), [line 131](https://github.com/jpcx/node-kraken-api/blob/0.4.0/index.js#L131) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/index.js), [line 131](https://github.com/jpcx/node-kraken-api/blob/0.4.1/index.js#L131) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -1,2 +0,2 @@ | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md)~Calls | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md)~Calls | ||
@@ -9,9 +9,9 @@ Types and methods specific to making direct API calls to Kraken. | ||
| --- | --- | --- | | ||
| `LoadCall` | [module:API/Calls/LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | Loads a stateful call function given the execution settings. | | ||
| `GenRequestData` | [module:API/Calls/GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | Generates request data for a given request. | | ||
| `SignRequest` | [module:API/Calls/SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | Applies a cryptographic signature to a given request. | | ||
| `LoadCall` | [module:API/Calls/LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | Loads a stateful call function given the execution settings. | | ||
| `GenRequestData` | [module:API/Calls/GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | Generates request data for a given request. | | ||
| `SignRequest` | [module:API/Calls/SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | Applies a cryptographic signature to a given request. | | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L7) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L7) | ||
@@ -30,13 +30,13 @@ ## Methods | ||
| --- | --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Options) | \<optional> | Method-specific options. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md#~Callback) | \<optional> | Optional callback for error or data. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Options) | \<optional> | Method-specific options. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md#~Callback) | \<optional> | Optional callback for error or data. | | ||
Source: | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js), [line 267](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js#L267) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js), [line 267](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js#L267) | ||
__Throws:__ | ||
Throws 'Invalid method' if method is not found in [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config). | ||
Throws 'Invalid method' if method is not found in [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config). | ||
@@ -65,3 +65,3 @@ ___Type:___ | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Instance settings. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Instance settings. | | ||
| `res` | Object | Provides an 'on' function which emits 'data' and 'end' events while receiving data chunks from request. | | ||
@@ -71,3 +71,3 @@ | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js#L14) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js#L14) | ||
@@ -92,8 +92,8 @@ __Returns:__ | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Instance settings. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Params) | Call parameters. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Instance settings. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Params) | Call parameters. | | ||
Source: | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js), [line 58](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js#L58) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js), [line 58](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js#L58) | ||
@@ -110,3 +110,3 @@ __Returns:__ | ||
### (inner) ParseArgs(settings, method, options, otp, cb) → \{[API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Arguments)} | ||
### (inner) ParseArgs(settings, method, options, otp, cb) → \{[API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Arguments)} | ||
@@ -119,11 +119,11 @@ Parses inputted arguments and reassigns them based on their type. Arguments will be successfully recognized regardless of omissions. | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~OTP) | Two-factor password. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md#~Callback) | Listener for errors and data. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~OTP) | Two-factor password. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md#~Callback) | Listener for errors and data. | | ||
Source: | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js), [line 186](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js#L186) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js), [line 186](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js#L186) | ||
@@ -144,3 +144,3 @@ __Throws:__ | ||
* [API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Arguments) | ||
* [API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Arguments) | ||
@@ -157,11 +157,11 @@ <a name="~ProcessCalls"></a> | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Execution settings configuraiton. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Category) | Rate-limit category. | | ||
| `thread` | [API\~Calls~Thread](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Thread) | Map of serialized parameters to listeners sets. | | ||
| `serialReg` | [API\~Calls~SerialRegistry](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~SerialRegistry) | Map of serialized params to actual parameter data. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Functions) | Rate-limit handler. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Execution settings configuraiton. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Category) | Rate-limit category. | | ||
| `thread` | [API\~Calls~Thread](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Thread) | Map of serialized parameters to listeners sets. | | ||
| `serialReg` | [API\~Calls~SerialRegistry](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~SerialRegistry) | Map of serialized params to actual parameter data. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Functions) | Rate-limit handler. | | ||
Source: | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js), [line 90](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js#L90) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js), [line 90](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js#L90) | ||
@@ -180,3 +180,3 @@ __Returns:__ | ||
Attaches calls to state maps. Launches dequeue operation if necessary. Recursively calls itself in response to call errors, depending on [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config).retryCt. | ||
Attaches calls to state maps. Launches dequeue operation if necessary. Recursively calls itself in response to call errors, depending on [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config).retryCt. | ||
@@ -187,11 +187,11 @@ __Parameters:__ | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Execution settings configuraiton. | | ||
| `state` | [API\~Calls~State](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~State) | Current state variables. | | ||
| `args` | [API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Arguments) | Call-specific arguments. | | ||
| `opListener` | [API\~Calls~OpListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~OpListener) | Listener error and data in order to resolve or reject the operational promise or to forward to the [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md#~Callback). | | ||
| `retryCt` | [API\~Calls~RetryCount](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~RetryCount) | Number of times call has been attempted. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Execution settings configuraiton. | | ||
| `state` | [API\~Calls~State](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~State) | Current state variables. | | ||
| `args` | [API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Arguments) | Call-specific arguments. | | ||
| `opListener` | [API\~Calls~OpListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~OpListener) | Listener error and data in order to resolve or reject the operational promise or to forward to the [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md#~Callback). | | ||
| `retryCt` | [API\~Calls~RetryCount](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~RetryCount) | Number of times call has been attempted. | | ||
Source: | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js), [line 139](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js#L139) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js), [line 139](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js#L139) | ||
@@ -214,9 +214,9 @@ ## Type Definitions | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Call method. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md#~Callback) | Callback for error or data. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Call method. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md#~Callback) | Callback for error or data. | | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 16](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L16) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 16](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L16) | ||
@@ -235,3 +235,3 @@ <a name="~CallData"></a> | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 51](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L51) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 51](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L51) | ||
@@ -250,3 +250,3 @@ <a name="~CallError"></a> | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 45](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L45) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 45](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L45) | ||
@@ -257,11 +257,11 @@ <a name="~CatThreads"></a> | ||
Holds maps of [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Params) to internal instances by rate-limit category. Different categories are executed in parallel. | ||
Holds maps of [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Params) to internal instances by rate-limit category. Different categories are executed in parallel. | ||
__Type:__ | ||
* Map.<[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Category), [API\~Calls~Thread](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Thread)> | ||
* Map.<[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Category), [API\~Calls~Thread](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Thread)> | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 101](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L101) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 101](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L101) | ||
@@ -276,7 +276,7 @@ <a name="~ListenerSet"></a> | ||
* Set.<[API\~Calls~RetryListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~RetryListener)> | ||
* Set.<[API\~Calls~RetryListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~RetryListener)> | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 107](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L107) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 107](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L107) | ||
@@ -293,8 +293,8 @@ <a name="~OpListener"></a> | ||
| --- | --- | --- | | ||
| `err` | Error | Any operational errors or [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~CallError) | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~CallData) | Data received from call. | | ||
| `err` | Error | Any operational errors or [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~CallError) | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~CallData) | Data received from call. | | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 83](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L83) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 83](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L83) | ||
@@ -315,8 +315,8 @@ <a name="~Params"></a> | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 57](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L57) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 57](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L57) | ||
@@ -337,8 +337,8 @@ <a name="~RequestData"></a> | ||
| --- | --- | --- | | ||
| `options` | [Kraken~HTTPSRequestOptions](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~HTTPSRequestOptions) | Options for HTTPS request to Kraken servers. | | ||
| `post` | [Kraken~HTTPSRequestPOSTData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~HTTPSRequestPOSTData) | POST data for HTTPS request to Kraken servers. | | ||
| `options` | [Kraken~HTTPSRequestOptions](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~HTTPSRequestOptions) | Options for HTTPS request to Kraken servers. | | ||
| `post` | [Kraken~HTTPSRequestPOSTData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~HTTPSRequestPOSTData) | POST data for HTTPS request to Kraken servers. | | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L31) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L31) | ||
@@ -357,3 +357,3 @@ <a name="~RetryCount"></a> | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 77](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L77) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 77](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L77) | ||
@@ -364,3 +364,3 @@ <a name="~RetryListener"></a> | ||
Listener created during call queueing; data is forwarded to [API\~Calls~OpListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~OpListener); errors trigger a retry attempt if possible- if not, they are forwarded to the [API\~Calls~OpListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~OpListener). | ||
Listener created during call queueing; data is forwarded to [API\~Calls~OpListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~OpListener); errors trigger a retry attempt if possible- if not, they are forwarded to the [API\~Calls~OpListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~OpListener). | ||
@@ -371,8 +371,8 @@ __Parameters:__ | ||
| --- | --- | --- | | ||
| `err` | Error | Any operational errors or [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~CallError) | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~CallData) | Data received from call. | | ||
| `err` | Error | Any operational errors or [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~CallError) | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~CallData) | Data received from call. | | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 92](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L92) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 92](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L92) | ||
@@ -383,3 +383,3 @@ <a name="~SerialParams"></a> | ||
Alphabetized and serialized [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Params) used for identifying multiple copies of the same call parameters. | ||
Alphabetized and serialized [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Params) used for identifying multiple copies of the same call parameters. | ||
@@ -392,3 +392,3 @@ __Type:__ | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 65](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L65) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 65](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L65) | ||
@@ -403,7 +403,7 @@ <a name="~SerialRegistry"></a> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~SerialParams), [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Params)> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~SerialParams), [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Params)> | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 71](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L71) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 71](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L71) | ||
@@ -422,3 +422,3 @@ <a name="~Signature"></a> | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 39](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L39) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 39](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L39) | ||
@@ -435,10 +435,10 @@ <a name="~State"></a> | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Execution settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter object. | | ||
| `catThreads` | [API\~Calls~CatThreads](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~CatThreads) | Category-based execution threads. | | ||
| `serialReg` | [API\~Calls~SerialRegistry](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~SerialRegistry) | Maps serialized params to actual params. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Execution settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Functions) | Limiter object. | | ||
| `catThreads` | [API\~Calls~CatThreads](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~CatThreads) | Category-based execution threads. | | ||
| `serialReg` | [API\~Calls~SerialRegistry](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~SerialRegistry) | Maps serialized params to actual params. | | ||
Source: | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js), [line 251](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/loadCall.js#L251) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js), [line 251](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/loadCall.js#L251) | ||
@@ -453,7 +453,7 @@ <a name="~Thread"></a> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~SerialParams), [API\~Calls~ListenerSet](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~ListenerSet)> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~SerialParams), [API\~Calls~ListenerSet](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~ListenerSet)> | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 113](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L113) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 113](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L113) | ||
@@ -472,23 +472,23 @@ <a name="~Timeout"></a> | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/calls/calls.jsdoc#L25) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/calls/calls.jsdoc#L25) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -1,2 +0,2 @@ | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md)~RateLimits | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md)~RateLimits | ||
@@ -9,7 +9,7 @@ Types and methods specific to dynamically limiting call frequency in response to rate limit violations and according to the rate limit specifications listed in the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) | ||
| --- | --- | --- | | ||
| `LoadLimiter` | [module:API/RateLimits/LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | Prepares rate-limiting promises according to the [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Tier), [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method), and [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~RateLimiter). | | ||
| `LoadLimiter` | [module:API/RateLimits/LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | Prepares rate-limiting promises according to the [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Tier), [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method), and [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~RateLimiter). | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/rateLimits.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/rateLimits.jsdoc#L7) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/rateLimits.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/rateLimits.jsdoc#L7) | ||
@@ -28,7 +28,7 @@ ## Methods | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 278](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L278) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 278](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L278) | ||
@@ -53,7 +53,7 @@ __Returns:__ | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 289](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L289) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 289](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L289) | ||
@@ -78,7 +78,7 @@ __Returns:__ | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 267](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L267) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 267](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L267) | ||
@@ -103,7 +103,7 @@ __Returns:__ | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 214](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L214) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 214](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L214) | ||
@@ -122,3 +122,3 @@ __Returns:__ | ||
Checks the response context for [API\~RateLimits~Update](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Update) and adjusts call frequency accordingly. | ||
Checks the response context for [API\~RateLimits~Update](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Update) and adjusts call frequency accordingly. | ||
@@ -130,9 +130,9 @@ __Parameters:__ | ||
| `context` | 'pass' \| 'fail' \| undefined | Reason for invocation; may be called in response to a successful call, a rate limit violation, or a pre-response call attempt. | | ||
| `limitConfig` | [API\~RateLimits~LimitConfig](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~LimitConfig) | Rate-limiter settings configuration. | | ||
| `any` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~CallInfo) | Rate information for all calls. | | ||
| `spec` | [API\~RateLimits~CatInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~CatInfo) | Rate information for specific [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Category). | | ||
| `limitConfig` | [API\~RateLimits~LimitConfig](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~LimitConfig) | Rate-limiter settings configuration. | | ||
| `any` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~CallInfo) | Rate information for all calls. | | ||
| `spec` | [API\~RateLimits~CatInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~CatInfo) | Rate information for specific [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Category). | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 71](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L71) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 71](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L71) | ||
@@ -149,12 +149,12 @@ <a name="~CheckPileUp"></a> | ||
| --- | --- | --- | | ||
| `limitConfig` | [API\~RateLimits~LimitConfig](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~LimitConfig) | Rate-limiter settings configuration. | | ||
| `any` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~CallInfo) | Rate information for all calls. | | ||
| `limitConfig` | [API\~RateLimits~LimitConfig](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~LimitConfig) | Rate-limiter settings configuration. | | ||
| `any` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~CallInfo) | Rate information for all calls. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 55](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L55) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 55](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L55) | ||
<a name="~GetAuthCounterLimit"></a> | ||
### (inner) GetAuthCounterLimit(tier) → \{[Kraken~AuthCounterLimit](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~AuthCounterLimit)} | ||
### (inner) GetAuthCounterLimit(tier) → \{[Kraken~AuthCounterLimit](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~AuthCounterLimit)} | ||
@@ -167,7 +167,7 @@ Returns the maximum counter value for authenticated methods. | ||
| --- | --- | --- | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Tier) | Kraken verification tier. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Tier) | Kraken verification tier. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L31) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L31) | ||
@@ -180,7 +180,7 @@ __Returns:__ | ||
* [Kraken~AuthCounterLimit](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~AuthCounterLimit) | ||
* [Kraken~AuthCounterLimit](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~AuthCounterLimit) | ||
<a name="~GetAuthDecrementInterval"></a> | ||
### (inner) GetAuthDecrementInterval(tier) → \{[Kraken~AuthDecrementInterval](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~AuthDecrementInterval)} | ||
### (inner) GetAuthDecrementInterval(tier) → \{[Kraken~AuthDecrementInterval](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~AuthDecrementInterval)} | ||
@@ -193,7 +193,7 @@ Returns the amount of time required to decrement the auth counter. | ||
| --- | --- | --- | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Tier) | Kraken verification tier. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Tier) | Kraken verification tier. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 21](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L21) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 21](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L21) | ||
@@ -206,7 +206,7 @@ __Returns:__ | ||
* [Kraken~AuthDecrementInterval](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~AuthDecrementInterval) | ||
* [Kraken~AuthDecrementInterval](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~AuthDecrementInterval) | ||
<a name="~GetAuthIncrementAmt"></a> | ||
### (inner) GetAuthIncrementAmt(method) → \{[Kraken~AuthIncrementAmount](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~AuthIncrementAmount)} | ||
### (inner) GetAuthIncrementAmt(method) → \{[Kraken~AuthIncrementAmount](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~AuthIncrementAmount)} | ||
@@ -219,7 +219,7 @@ Returns the amount of counter incrementation based on the method. | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 9](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L9) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 9](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L9) | ||
@@ -232,3 +232,3 @@ __Returns:__ | ||
* [Kraken~AuthIncrementAmount](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~AuthIncrementAmount) | ||
* [Kraken~AuthIncrementAmount](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~AuthIncrementAmount) | ||
@@ -245,8 +245,8 @@ <a name="~GetAuthRegenIntvl"></a> | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Tier) | Current verification tier. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Tier) | Current verification tier. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 308](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L308) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 308](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L308) | ||
@@ -263,5 +263,5 @@ __Returns:__ | ||
### (inner) GetCategory(method) → \{[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Category)} | ||
### (inner) GetCategory(method) → \{[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Category)} | ||
Gets the type of server-side rate-limiter category based on the method. Wrapper for [API\~RateLimits~GetRLCategory](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~GetRLCategory). | ||
Gets the type of server-side rate-limiter category based on the method. Wrapper for [API\~RateLimits~GetRLCategory](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~GetRLCategory). | ||
@@ -272,7 +272,7 @@ __Parameters:__ | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 300](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L300) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 300](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L300) | ||
@@ -285,7 +285,7 @@ __Returns:__ | ||
* [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Category) | ||
* [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Category) | ||
<a name="~GetRLCategory"></a> | ||
### (inner) GetRLCategory(privMethods, method) → \{[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Category)} | ||
### (inner) GetRLCategory(privMethods, method) → \{[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Category)} | ||
@@ -298,8 +298,8 @@ Returns the rate-limit category for a given method. Different categories follow different server-side limiting behavior. | ||
| --- | --- | --- | | ||
| `privMethods` | [Kraken~PrivateMethods](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~PrivateMethods) | List of all available private methods. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `privMethods` | [Kraken~PrivateMethods](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~PrivateMethods) | List of all available private methods. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 40](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L40) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 40](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L40) | ||
@@ -312,3 +312,3 @@ __Returns:__ | ||
* [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Category) | ||
* [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Category) | ||
@@ -319,3 +319,3 @@ <a name="~Update"></a> | ||
Updates [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~CallInfo) and [API\~RateLimits~CatInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~CatInfo) intervals in response to server response behavior. | ||
Updates [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~CallInfo) and [API\~RateLimits~CatInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~CatInfo) intervals in response to server response behavior. | ||
@@ -326,4 +326,4 @@ __Parameters:__ | ||
| --- | --- | --- | --- | | ||
| `state` | [API\~RateLimits~State](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~State) | | Stateful registry of limiter information. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `state` | [API\~RateLimits~State](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~State) | | Stateful registry of limiter information. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `context` | 'pass' \| 'fail' | \<optional> | Reason for invocation; may be called in response to a successful call, a rate limit violation, or a pre-response call attempt. | | ||
@@ -333,3 +333,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 100](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L100) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 100](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L100) | ||
@@ -358,3 +358,3 @@ ## Type Definitions | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/rateLimits.jsdoc), [line 20](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/rateLimits.jsdoc#L20) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/rateLimits.jsdoc), [line 20](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/rateLimits.jsdoc#L20) | ||
@@ -373,3 +373,3 @@ <a name="~Category"></a> | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/rateLimits.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/rateLimits.jsdoc#L14) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/rateLimits.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/rateLimits.jsdoc#L14) | ||
@@ -395,3 +395,3 @@ <a name="~CatInfo"></a> | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/rateLimits.jsdoc), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/rateLimits.jsdoc#L35) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/rateLimits.jsdoc), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/rateLimits.jsdoc#L35) | ||
@@ -412,11 +412,11 @@ <a name="~Functions"></a> | ||
| --- | --- | --- | | ||
| `attempt` | [API\~RateLimits~Attempt](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Attempt) | Register a new call attempt. | | ||
| `addPass` | [API\~RateLimits~AddPass](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~AddPass) | Register a new successful call response. | | ||
| `addFail` | [API\~RateLimits~AddFail](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~AddFail) | Register a new rate-limit violation. | | ||
| `getCategory` | [API\~RateLimits~GetCategory](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~GetCategory) | Gets the type of rate-limiting behavior based on the method. | | ||
| `getAuthRegenIntvl` | [API\~RateLimits~GetAuthRegenIntvl](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~GetAuthRegenIntvl) | Gets the amount of time necessary for a given private method to be called sustainably. | | ||
| `attempt` | [API\~RateLimits~Attempt](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Attempt) | Register a new call attempt. | | ||
| `addPass` | [API\~RateLimits~AddPass](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~AddPass) | Register a new successful call response. | | ||
| `addFail` | [API\~RateLimits~AddFail](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~AddFail) | Register a new rate-limit violation. | | ||
| `getCategory` | [API\~RateLimits~GetCategory](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~GetCategory) | Gets the type of rate-limiting behavior based on the method. | | ||
| `getAuthRegenIntvl` | [API\~RateLimits~GetAuthRegenIntvl](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~GetAuthRegenIntvl) | Gets the amount of time necessary for a given private method to be called sustainably. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 203](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L203) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 203](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L203) | ||
@@ -452,3 +452,3 @@ <a name="~LimitConfig"></a> | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/rateLimits.jsdoc), [line 43](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/rateLimits.jsdoc#L43) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/rateLimits.jsdoc), [line 43](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/rateLimits.jsdoc#L43) | ||
@@ -465,30 +465,30 @@ <a name="~State"></a> | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `limitConfig` | [API\~RateLimits~LimitConfig](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~LimitConfig) | Rate limter behavior configuration. | | ||
| `calls` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~CallInfo) | Rate info for all calls. | | ||
| `catInfo` | [API\~RateLimits~CatInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~CatInfo) | Map of category to object containing category-specific rate information. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `limitConfig` | [API\~RateLimits~LimitConfig](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~LimitConfig) | Rate limter behavior configuration. | | ||
| `calls` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~CallInfo) | Rate info for all calls. | | ||
| `catInfo` | [API\~RateLimits~CatInfo](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~CatInfo) | Map of category to object containing category-specific rate information. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js), [line 167](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/rateLimits/loadLimiter.js#L167) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js), [line 167](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/rateLimits/loadLimiter.js#L167) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -1,4 +0,4 @@ | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md)~Syncing | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md)~Syncing | ||
Types and methods specific to scheduling persistent [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Call) operations. | ||
Types and methods specific to scheduling persistent [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Call) operations. | ||
@@ -9,7 +9,7 @@ __Properties:__ | ||
| --- | --- | --- | | ||
| `LoadSync` | [module:API/Syncing/LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | Loads settings and loaded call function and returns stateful sync creation function. | | ||
| `LoadSync` | [module:API/Syncing/LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | Loads settings and loaded call function and returns stateful sync creation function. | | ||
Source: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc#L7) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc#L7) | ||
@@ -22,3 +22,3 @@ ## Methods | ||
Associates a new [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener) with the instance. | ||
Associates a new [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener) with the instance. | ||
@@ -29,7 +29,7 @@ __Parameters:__ | ||
| --- | --- | --- | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener) | Listener function to add. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener) | Listener function to add. | | ||
Source: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js), [line 443](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js#L443) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js), [line 443](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js#L443) | ||
@@ -52,3 +52,3 @@ __Returns:__ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js), [line 416](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js#L416) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js), [line 416](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js#L416) | ||
@@ -67,3 +67,3 @@ __Returns:__ | ||
Handles request queue and sends data to associated [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener)s. | ||
Handles request queue and sends data to associated [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener)s. | ||
@@ -74,8 +74,8 @@ __Parameters:__ | ||
| --- | --- | --- | | ||
| `state` | [API\~Syncing~State](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Category) | Current rate-limit category. | | ||
| `state` | [API\~Syncing~State](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Category) | Current rate-limit category. | | ||
Source: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js), [line 132](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js#L132) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js), [line 132](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js#L132) | ||
@@ -94,3 +94,3 @@ __Returns:__ | ||
Adds a one-time [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener) to the instance. If no listener is provided as a parameter, returns a promise which resolves with the next update's error or data. | ||
Adds a one-time [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener) to the instance. If no listener is provided as a parameter, returns a promise which resolves with the next update's error or data. | ||
@@ -101,7 +101,7 @@ __Parameters:__ | ||
| --- | --- | --- | --- | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener) | \<optional> | Once listener function to add. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener) | \<optional> | Once listener function to add. | | ||
Source: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js), [line 459](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js#L459) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js), [line 459](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js#L459) | ||
@@ -124,3 +124,3 @@ __Returns:__ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js), [line 372](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js#L372) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js), [line 372](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js#L372) | ||
@@ -137,3 +137,3 @@ __Returns:__ | ||
### (inner) ParseArgs(settings, method, options, interval, listener) → \{[API\~Syncing~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Arguments)} | ||
### (inner) ParseArgs(settings, method, options, interval, listener) → \{[API\~Syncing~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Arguments)} | ||
@@ -146,11 +146,11 @@ Parses inputted arguments and reassigns them based on their type. Arguments will be successfully recognized regardless of omissions. | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener) | Listener for errors and data. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener) | Listener for errors and data. | | ||
Source: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js), [line 209](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js#L209) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js), [line 209](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js#L209) | ||
@@ -171,3 +171,3 @@ __Throws:__ | ||
* [API\~Syncing~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Arguments) | ||
* [API\~Syncing~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Arguments) | ||
@@ -178,3 +178,3 @@ <a name="~RemoveListener"></a> | ||
Disassociates an [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener) from the instance. | ||
Disassociates an [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener) from the instance. | ||
@@ -185,7 +185,7 @@ __Parameters:__ | ||
| --- | --- | --- | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener) | Listener function to remove. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener) | Listener function to remove. | | ||
Source: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js), [line 451](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js#L451) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js), [line 451](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js#L451) | ||
@@ -202,3 +202,3 @@ __Returns:__ | ||
### (inner) Sync(method, optionsopt, intervalopt, listeneropt) → \{[API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Instance)} | ||
### (inner) Sync(method, optionsopt, intervalopt, listeneropt) → \{[API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Instance)} | ||
@@ -211,10 +211,10 @@ Stateful function which creates sync instances. Any argument (except method) may be omitted and replaced with another, as long as the order \[options, interval, listener\] is preserved. | ||
| --- | --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Options) | \<optional> | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Interval) | \<optional> | Minimum update interval for sync operation. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener) | \<optional> | Listener for error and data events. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Options) | \<optional> | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Interval) | \<optional> | Minimum update interval for sync operation. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener) | \<optional> | Listener for error and data events. | | ||
Source: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js), [line 307](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js#L307) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js), [line 307](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js#L307) | ||
@@ -235,3 +235,3 @@ __Throws:__ | ||
* [API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Instance) | ||
* [API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Instance) | ||
@@ -248,10 +248,10 @@ <a name="~VerifyInternals"></a> | ||
| --- | --- | --- | | ||
| `state` | [API\~Syncing~State](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Category) | Rate limiting category of the current thread. | | ||
| `serial` | [API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~SerialParams) | Serial currently associated with the call that triggered verifyInternals. | | ||
| `internals` | [API\~Syncing~InternalSet](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~InternalSet) | Set of all internals associated with the current thread. | | ||
| `state` | [API\~Syncing~State](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Category) | Rate limiting category of the current thread. | | ||
| `serial` | [API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~SerialParams) | Serial currently associated with the call that triggered verifyInternals. | | ||
| `internals` | [API\~Syncing~InternalSet](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~InternalSet) | Set of all internals associated with the current thread. | | ||
Source: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js), [line 11](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js#L11) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js), [line 11](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js#L11) | ||
@@ -274,9 +274,9 @@ ## Type Definitions | ||
| --- | --- | --- | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener) | Event listener for sync error and data events. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener) | Event listener for sync error and data events. | | ||
Source: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc#L14) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc#L14) | ||
@@ -287,11 +287,11 @@ <a name="~CatThreads"></a> | ||
Holds maps of [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Params) to internal instances by rate-limit category. Different categories are executed in parallel. | ||
Holds maps of [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Params) to internal instances by rate-limit category. Different categories are executed in parallel. | ||
__Type:__ | ||
* Map.<[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Category), [API\~Syncing~Thread](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Thread)> | ||
* Map.<[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Category), [API\~Syncing~Thread](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Thread)> | ||
Source: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc), [line 57](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc#L57) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc), [line 57](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc#L57) | ||
@@ -302,3 +302,3 @@ <a name="~Error"></a> | ||
Timestamped [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~CallError) (or other execution error) which is added to the instance error array and sent to any available listeners. | ||
Timestamped [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~CallError) (or other execution error) which is added to the instance error array and sent to any available listeners. | ||
@@ -317,3 +317,3 @@ __Type:__ | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc), [line 50](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc#L50) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc), [line 50](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc#L50) | ||
@@ -330,9 +330,9 @@ <a name="~EventListener"></a> | ||
| --- | --- | --- | --- | | ||
| `err` | [API\~Syncing~Error](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Error) | | Sync error. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~CallData) | | Data received from call. | | ||
| `instance` | [API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Instance) | \<optional> | Reference to the current instance, if necessary. | | ||
| `err` | [API\~Syncing~Error](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Error) | | Sync error. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~CallData) | | Data received from call. | | ||
| `instance` | [API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Instance) | \<optional> | Reference to the current instance, if necessary. | | ||
Source: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc), [line 41](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc#L41) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc), [line 41](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc#L41) | ||
@@ -353,17 +353,17 @@ <a name="~Instance"></a> | ||
| --- | --- | --- | | ||
| `status` | [API\~Syncing~Status](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Status) | Current status of the instance. Set to 'init' until request attempt, 'open' when active, and 'closed' when not. Note: changing this value during runtime will not change instance behaviors; use the associated 'open' and 'close' methods instead. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update time. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Current method associated with the instance. Changes to this value during runtime will result in thread reassignment if valid; if invalid, will be reverted and will notify the event listeners with an 'Invalid method' error. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Options) | Current method-specific options. Changes to this value during runtime will result in map reassignment if valid; if invalid (not an object), will be reverted and will notify the event listeners with an 'Invalid options' error. | | ||
| `data` | [API\~Syncing~InstanceData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~InstanceData) | Object containing data from the last successful response. | | ||
| `time` | number | Time (in ms) of last successful [API\~Syncing~InstanceData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~InstanceData) update. | | ||
| `open` | [API\~Syncing~Open](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Open) | Opens the instance if closed. | | ||
| `close` | [API\~Syncing~Close](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Close) | Closes the instance if open. | | ||
| `addListener` | [API\~Syncing~AddListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~AddListener) | Associates a new [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener). | | ||
| `removeListener` | [API\~Syncing~RemoveListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~RemoveListener) | Disassociates a [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener). | | ||
| `once` | [API\~Syncing~Once](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Once) | Adds a one-time [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener) if provided; otherwise returns a promise which resolves/rejects on the next error/data event. | | ||
| `status` | [API\~Syncing~Status](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Status) | Current status of the instance. Set to 'init' until request attempt, 'open' when active, and 'closed' when not. Note: changing this value during runtime will not change instance behaviors; use the associated 'open' and 'close' methods instead. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update time. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Current method associated with the instance. Changes to this value during runtime will result in thread reassignment if valid; if invalid, will be reverted and will notify the event listeners with an 'Invalid method' error. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Options) | Current method-specific options. Changes to this value during runtime will result in map reassignment if valid; if invalid (not an object), will be reverted and will notify the event listeners with an 'Invalid options' error. | | ||
| `data` | [API\~Syncing~InstanceData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~InstanceData) | Object containing data from the last successful response. | | ||
| `time` | number | Time (in ms) of last successful [API\~Syncing~InstanceData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~InstanceData) update. | | ||
| `open` | [API\~Syncing~Open](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Open) | Opens the instance if closed. | | ||
| `close` | [API\~Syncing~Close](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Close) | Closes the instance if open. | | ||
| `addListener` | [API\~Syncing~AddListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~AddListener) | Associates a new [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener). | | ||
| `removeListener` | [API\~Syncing~RemoveListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~RemoveListener) | Disassociates a [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener). | | ||
| `once` | [API\~Syncing~Once](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Once) | Adds a one-time [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener) if provided; otherwise returns a promise which resolves/rejects on the next error/data event. | | ||
Source: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js), [line 328](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js#L328) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js), [line 328](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js#L328) | ||
@@ -374,3 +374,3 @@ <a name="~InstanceData"></a> | ||
Data value of the instance. Defaults to an object that is replaced with [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~CallData) upon every successful call, but may be customized within an [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener) or otherwise. | ||
Data value of the instance. Defaults to an object that is replaced with [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~CallData) upon every successful call, but may be customized within an [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener) or otherwise. | ||
@@ -383,3 +383,3 @@ __Type:__ | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc), [line 23](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc#L23) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc), [line 23](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc#L23) | ||
@@ -400,12 +400,12 @@ <a name="~Internal"></a> | ||
| --- | --- | --- | | ||
| `status` | [API\~Syncing~Status](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Status) | Current status of the request. | | ||
| `status` | [API\~Syncing~Status](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Status) | Current status of the request. | | ||
| `paused` | boolean | Whether or not sync updates are paused due to interval. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Params) | Object containing method and options. | | ||
| `instance` | [API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Instance) | Instance being tracked. | | ||
| `listeners` | Set.<[API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~EventListener)> | Set of all associated event listeners. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Params) | Object containing method and options. | | ||
| `instance` | [API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Instance) | Instance being tracked. | | ||
| `listeners` | Set.<[API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~EventListener)> | Set of all associated event listeners. | | ||
Source: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js), [line 348](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js#L348) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js), [line 348](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js#L348) | ||
@@ -420,7 +420,7 @@ <a name="~InternalSet"></a> | ||
* Set.<[API\~Syncing~Internal](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~Internal)> | ||
* Set.<[API\~Syncing~Internal](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~Internal)> | ||
Source: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc), [line 69](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc#L69) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc), [line 69](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc#L69) | ||
@@ -439,3 +439,3 @@ <a name="~Interval"></a> | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc#L35) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc#L35) | ||
@@ -456,11 +456,11 @@ <a name="~State"></a> | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | Settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Call) | Stateful call function. | | ||
| `catThreads` | [API\~Syncing~CatThreads](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~CatThreads) | Map of category to map of serials to internals set. | | ||
| `serialReg` | [API\~Calls~SerialRegistry](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~SerialRegistry) | Maps serialized params to actual params. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | Settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Call) | Stateful call function. | | ||
| `catThreads` | [API\~Syncing~CatThreads](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~CatThreads) | Map of category to map of serials to internals set. | | ||
| `serialReg` | [API\~Calls~SerialRegistry](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~SerialRegistry) | Maps serialized params to actual params. | | ||
Source: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js), [line 290](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/loadSync.js#L290) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js), [line 290](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/loadSync.js#L290) | ||
@@ -471,3 +471,3 @@ <a name="~Status"></a> | ||
Current state of the instance's request. 'init' if first [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~CallData) has not been received; 'open' if queued; 'closed' if not queued. | ||
Current state of the instance's request. 'init' if first [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~CallData) has not been received; 'open' if queued; 'closed' if not queued. | ||
@@ -480,3 +480,3 @@ __Type:__ | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc), [line 29](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc#L29) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc), [line 29](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc#L29) | ||
@@ -491,27 +491,27 @@ <a name="~Thread"></a> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~SerialParams), [API\~Syncing~InternalSet](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md#~InternalSet)> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~SerialParams), [API\~Syncing~InternalSet](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md#~InternalSet)> | ||
Source: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc), [line 63](https://github.com/jpcx/node-kraken-api/blob/0.4.0/api/syncing/syncing.jsdoc#L63) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc), [line 63](https://github.com/jpcx/node-kraken-api/blob/0.4.1/api/syncing/syncing.jsdoc#L63) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -7,3 +7,3 @@ # Kraken | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L7) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L7) | ||
@@ -16,11 +16,11 @@ ## Type Definitions | ||
Positive integer counter limit used for determining private API rate limit adherence. Depends on the [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Tier). See the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) for more information. | ||
Positive integer counter limit used for determining private API rate limit adherence. Depends on the [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Tier). See the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) for more information. | ||
__Type:__ | ||
* [Kraken~AuthRateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~AuthRateLimitCount) | ||
* [Kraken~AuthRateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~AuthRateLimitCount) | ||
Source: | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 122](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L122) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 122](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L122) | ||
@@ -31,3 +31,3 @@ <a name="~AuthDecrementInterval"></a> | ||
Number of seconds for the [Kraken~AuthRateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~AuthRateLimitCount) to decrement by one. Depends on the [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Tier). See the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) for more information. | ||
Number of seconds for the [Kraken~AuthRateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~AuthRateLimitCount) to decrement by one. Depends on the [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Tier). See the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) for more information. | ||
@@ -40,3 +40,3 @@ __Type:__ | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 134](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L134) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 134](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L134) | ||
@@ -47,11 +47,11 @@ <a name="~AuthIncrementAmount"></a> | ||
Positive integer counter increment amount used for determining private API rate limit adherence. Depends on the [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method). See the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) for more information. | ||
Positive integer counter increment amount used for determining private API rate limit adherence. Depends on the [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method). See the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) for more information. | ||
__Type:__ | ||
* [Kraken~AuthRateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~AuthRateLimitCount) | ||
* [Kraken~AuthRateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~AuthRateLimitCount) | ||
Source: | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 128](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L128) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 128](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L128) | ||
@@ -70,3 +70,3 @@ <a name="~AuthRateLimitCount"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 116](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L116) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 116](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L116) | ||
@@ -85,3 +85,3 @@ <a name="~Hostname"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 80](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L80) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 80](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L80) | ||
@@ -102,8 +102,8 @@ <a name="~HTTPSRequestHeaders"></a> | ||
| --- | --- | --- | | ||
| `API-Key` | [Kraken~Key](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Key) | Kraken API key. | | ||
| `API-Sign` | [API\~Calls~Signature](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Signature) | Cryptographic signature using API secret and other call parameters. | | ||
| `API-Key` | [Kraken~Key](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Key) | Kraken API key. | | ||
| `API-Sign` | [API\~Calls~Signature](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Signature) | Cryptographic signature using API secret and other call parameters. | | ||
Source: | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 92](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L92) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 92](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L92) | ||
@@ -124,10 +124,10 @@ <a name="~HTTPSRequestOptions"></a> | ||
| --- | --- | --- | | ||
| `hostname` | [Kraken~Hostname](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Hostname) | Kraken hostname. | | ||
| `path` | [Kraken~Path](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Path) | Kraken method path. | | ||
| `method` | string | 'POST' HTTPS request specification. NOTE: This is NOT the same as the [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) for the request. | | ||
| `headers` | [Kraken~HTTPSRequestHeaders](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~HTTPSRequestHeaders) | Kraken HTTPS request headers. | | ||
| `hostname` | [Kraken~Hostname](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Hostname) | Kraken hostname. | | ||
| `path` | [Kraken~Path](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Path) | Kraken method path. | | ||
| `method` | string | 'POST' HTTPS request specification. NOTE: This is NOT the same as the [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) for the request. | | ||
| `headers` | [Kraken~HTTPSRequestHeaders](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~HTTPSRequestHeaders) | Kraken HTTPS request headers. | | ||
Source: | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 100](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L100) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 100](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L100) | ||
@@ -146,3 +146,3 @@ <a name="~HTTPSRequestPOSTData"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 110](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L110) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 110](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L110) | ||
@@ -161,3 +161,3 @@ <a name="~Key"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L13) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L13) | ||
@@ -176,3 +176,3 @@ <a name="~Method"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 55](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L55) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 55](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L55) | ||
@@ -191,3 +191,3 @@ <a name="~Nonce"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 74](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L74) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 74](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L74) | ||
@@ -206,3 +206,3 @@ <a name="~Option"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 61](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L61) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 61](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L61) | ||
@@ -223,7 +223,7 @@ <a name="~Options"></a> | ||
| --- | --- | --- | | ||
| `*` | [Kraken~Option](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Option) | An option to send to the servers. | | ||
| `*` | [Kraken~Option](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Option) | An option to send to the servers. | | ||
Source: | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 67](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L67) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 67](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L67) | ||
@@ -242,3 +242,3 @@ <a name="~OTP"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L31) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L31) | ||
@@ -257,3 +257,3 @@ <a name="~Path"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 86](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L86) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 86](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L86) | ||
@@ -272,3 +272,3 @@ <a name="~PrivateMethods"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 49](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L49) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 49](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L49) | ||
@@ -287,3 +287,3 @@ <a name="~PublicMethods"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 43](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L43) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 43](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L43) | ||
@@ -302,3 +302,3 @@ <a name="~Secret"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 19](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L19) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 19](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L19) | ||
@@ -317,3 +317,3 @@ <a name="~Tier"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L25) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L25) | ||
@@ -332,23 +332,23 @@ <a name="~Version"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc), [line 37](https://github.com/jpcx/node-kraken-api/blob/0.4.0/kraken/kraken.jsdoc#L37) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc), [line 37](https://github.com/jpcx/node-kraken-api/blob/0.4.1/kraken/kraken.jsdoc#L37) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -9,7 +9,7 @@ # Settings | ||
| --- | --- | --- | | ||
| `ParseSettings` | [module:Settings/ParseSettings](module-Settings_Parsehttps://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | Parses user-provided settings, throws errors if necessary, and combines with defaults. | | ||
| `ParseSettings` | [module:Settings/ParseSettings](module-Settings_Parsehttps://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | Parses user-provided settings, throws errors if necessary, and combines with defaults. | | ||
Source: | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/settings/settings.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.0/settings/settings.jsdoc#L7) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/settings/settings.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.1/settings/settings.jsdoc#L7) | ||
@@ -32,20 +32,20 @@ ## Type Definitions | ||
| --- | --- | --- | --- | --- | | ||
| `key` | [Kraken~Key](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Key) | \<optional> | '' | API key. | | ||
| `secret` | [Kraken~Secret](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Secret) | \<optional> | '' | API secret. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Tier) | \<optional> | 0 | Verification tier. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~OTP) | \<optional> | null | Two factor password. | | ||
| `timeout` | [API\~Calls~Timeout](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~Timeout) | \<optional> | 5000 | Response timeout in ms. | | ||
| `retryct` | [API\~Calls~RetryCount](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~RetryCount) | \<optional> | 3 | Maximum number of times to automatically retry a call after an error. | | ||
| `hostname` | [Kraken~Hostname](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Hostname) | \<optional> | 'api.kraken.com' | Hostname of the Kraken API endpoint. | | ||
| `version` | [Kraken~Version](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Version) | \<optional> | 0 | Kraken API version. | | ||
| `pubMethods` | [Kraken~PublicMethods](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~PublicMethods) | \<optional> | \[ 'Time', 'Assets','AssetPairs', 'Ticker','OHLC', 'Depth', 'Trades', 'Spread' \] | API methods available for public users. | | ||
| `privMethods` | [Kraken~PrivateMethods](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~PrivateMethods) | \<optional> | \[ 'Balance', 'TradeBalance', 'OpenOrders', 'ClosedOrders', 'QueryOrders', 'TradesHistory', 'QueryTrades', 'OpenPositions', 'Ledgers', 'QueryLedgers', 'TradeVolume', 'AddOrder', 'CancelOrder', 'DepositMethods', 'DepositAddresses', 'DepositStatus', 'WithdrawInfo', 'Withdraw', 'WithdrawStatus', 'WithdrawCancel' \] | API methods available for authenticated users. | | ||
| `parse` | [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md#~ParseNestedConfig) | \<optional> | { numbers: true, dates: true } | Response parser settings. | | ||
| `limiter` | [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~RateLimiter) | \<optional> | { baseIntvl: 500, minIntvl: 250 } | Settings for call interval limitations. | | ||
| `syncIntervals` | [Settings~SyncIntervals](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~SyncIntervals) | \<optional> | { Time: 2000, Assets: 2000, AssetPairs: 2000, Ticker: 2000, OHLC: 60000, Depth: 2000, Trades: 2000, Spread: 2000 } | | | ||
| `dataFormatter` | [Settings~DataFormatter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~DataFormatter) | \<optional> | null | Function for response data formatting (post-parsing, if enabled). | | ||
| `key` | [Kraken~Key](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Key) | \<optional> | '' | API key. | | ||
| `secret` | [Kraken~Secret](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Secret) | \<optional> | '' | API secret. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Tier) | \<optional> | 0 | Verification tier. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~OTP) | \<optional> | null | Two factor password. | | ||
| `timeout` | [API\~Calls~Timeout](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~Timeout) | \<optional> | 5000 | Response timeout in ms. | | ||
| `retryct` | [API\~Calls~RetryCount](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~RetryCount) | \<optional> | 3 | Maximum number of times to automatically retry a call after an error. | | ||
| `hostname` | [Kraken~Hostname](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Hostname) | \<optional> | 'api.kraken.com' | Hostname of the Kraken API endpoint. | | ||
| `version` | [Kraken~Version](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Version) | \<optional> | 0 | Kraken API version. | | ||
| `pubMethods` | [Kraken~PublicMethods](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~PublicMethods) | \<optional> | \[ 'Time', 'Assets','AssetPairs', 'Ticker','OHLC', 'Depth', 'Trades', 'Spread' \] | API methods available for public users. | | ||
| `privMethods` | [Kraken~PrivateMethods](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~PrivateMethods) | \<optional> | \[ 'Balance', 'TradeBalance', 'OpenOrders', 'ClosedOrders', 'QueryOrders', 'TradesHistory', 'QueryTrades', 'OpenPositions', 'Ledgers', 'QueryLedgers', 'TradeVolume', 'AddOrder', 'CancelOrder', 'DepositMethods', 'DepositAddresses', 'DepositStatus', 'WithdrawInfo', 'Withdraw', 'WithdrawStatus', 'WithdrawCancel' \] | API methods available for authenticated users. | | ||
| `parse` | [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md#~ParseNestedConfig) | \<optional> | { numbers: true, dates: true } | Response parser settings. | | ||
| `limiter` | [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~RateLimiter) | \<optional> | { baseIntvl: 500, minIntvl: 250 } | Settings for call interval limitations. | | ||
| `syncIntervals` | [Settings~SyncIntervals](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~SyncIntervals) | \<optional> | { Time: 2000, Assets: 2000, AssetPairs: 2000, Ticker: 2000, OHLC: 60000, Depth: 2000, Trades: 2000, Spread: 2000 } | | | ||
| `dataFormatter` | [Settings~DataFormatter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~DataFormatter) | \<optional> | null | Function for response data formatting (post-parsing, if enabled). | | ||
Source: | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/settings/settings.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.4.0/settings/settings.jsdoc#L14) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/settings/settings.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.4.1/settings/settings.jsdoc#L14) | ||
@@ -62,9 +62,9 @@ <a name="~DataFormatter"></a> | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md#~CallData) | Data received from call (post-parsing, if enabled). | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md#~CallData) | Data received from call (post-parsing, if enabled). | | ||
Source: | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/settings/settings.jsdoc), [line 49](https://github.com/jpcx/node-kraken-api/blob/0.4.0/settings/settings.jsdoc#L49) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/settings/settings.jsdoc), [line 49](https://github.com/jpcx/node-kraken-api/blob/0.4.1/settings/settings.jsdoc#L49) | ||
@@ -98,3 +98,3 @@ __Returns:__ | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/settings/settings.jsdoc), [line 34](https://github.com/jpcx/node-kraken-api/blob/0.4.0/settings/settings.jsdoc#L34) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/settings/settings.jsdoc), [line 34](https://github.com/jpcx/node-kraken-api/blob/0.4.1/settings/settings.jsdoc#L34) | ||
@@ -115,27 +115,27 @@ <a name="~SyncIntervals"></a> | ||
| --- | --- | --- | | ||
| `*` | number | Name of [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md#~Method) and default interval (in ms). | | ||
| `*` | number | Name of [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md#~Method) and default interval (in ms). | | ||
Source: | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/settings/settings.jsdoc), [line 42](https://github.com/jpcx/node-kraken-api/blob/0.4.0/settings/settings.jsdoc#L42) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/settings/settings.jsdoc), [line 42](https://github.com/jpcx/node-kraken-api/blob/0.4.1/settings/settings.jsdoc#L42) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
@@ -9,8 +9,8 @@ # Tools | ||
| --- | --- | --- | | ||
| `AlphabetizeNested` | [module:Tools/AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | Alphabetizes a nested Object. | | ||
| `ParseNested` | [module:Tools/ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | Parses a nested Object, Array, Map, or Set according to the rules defined in Settings~Parse | | ||
| `AlphabetizeNested` | [module:Tools/AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | Alphabetizes a nested Object. | | ||
| `ParseNested` | [module:Tools/ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | Parses a nested Object, Array, Map, or Set according to the rules defined in Settings~Parse | | ||
Source: | ||
* [node-kraken-api/tools/tools.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/tools/tools.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.0/tools/tools.jsdoc#L7) | ||
* [node-kraken-api/tools/tools.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/tools/tools.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.4.1/tools/tools.jsdoc#L7) | ||
@@ -36,23 +36,23 @@ ## Type Definitions | ||
* [node-kraken-api/tools/tools.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.0/tools/tools.jsdoc), [line 15](https://github.com/jpcx/node-kraken-api/blob/0.4.0/tools/tools.jsdoc#L15) | ||
* [node-kraken-api/tools/tools.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.4.1/tools/tools.jsdoc), [line 15](https://github.com/jpcx/node-kraken-api/blob/0.4.1/tools/tools.jsdoc#L15) | ||
___ | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.0/README.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.4.1/README.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) |
{ | ||
"name": "node-kraken-api", | ||
"version": "0.4.0", | ||
"version": "0.4.1", | ||
"description": "Interfaces with the Kraken cryptocurrency exchange API. Observes rate limits. Parses response JSON, converts stringed numbers, and normalizes timestamps. Facilitates persistent data syncing.", | ||
@@ -5,0 +5,0 @@ "engines": { |
@@ -174,3 +174,3 @@ # node-kraken-api | ||
Response data may be formatted in any way based on method and options by setting a [DataFormatter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~DataFormatter) function during instantiation. | ||
Response data may be formatted in any way based on method and options by setting a [DataFormatter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~DataFormatter) function during instantiation. | ||
@@ -441,3 +441,3 @@ ___NOTE:___ Any data returned from this function will be treated as the new data, and call responses will be undefined if it does not return anything. | ||
Configuration specifications are detailed in the documentation [here](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) | ||
Configuration specifications are detailed in the documentation [here](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) | ||
@@ -466,3 +466,3 @@ Additionally, various settings may be modified during runtime by using the following functions: | ||
Alternatively, refer to the [default settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md#~Config) in the node-kraken-api documentation. Default method types are listed here (under the 'pubMethods' and 'privMethods' properties). | ||
Alternatively, refer to the [default settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md#~Config) in the node-kraken-api documentation. Default method types are listed here (under the 'pubMethods' and 'privMethods' properties). | ||
@@ -482,22 +482,22 @@ Method options are found under the 'Input:' section. For example, 'Get order book' lists the following: | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.0/docs/namespaces/Kraken.md) | ||
* [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/node-kraken-api.md) | ||
* [API](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API.md) | ||
* [Calls](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Calls.md) | ||
* [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/GenRequestData.md) | ||
* [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/LoadCall.md) | ||
* [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Calls/SignRequest.md) | ||
* [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/RateLimits.md) | ||
* [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
* [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/API/Syncing.md) | ||
* [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/API/Syncing/LoadSync.md) | ||
* [Settings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Settings.md) | ||
* [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Settings/ParseSettings.md) | ||
* [Tools](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Tools.md) | ||
* [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/AlphabetizeNested.md) | ||
* [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/modules/Tools/ParseNested.md) | ||
* [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.4.1/docs/namespaces/Kraken.md) | ||
## Versioning | ||
Versioned using [SemVer](http://semver.org/). For available versions, see the [Changelog](https://github.com/jpcx/node-kraken-api/blob/0.4.0/CHANGELOG.md). | ||
Versioned using [SemVer](http://semver.org/). For available versions, see the [Changelog](https://github.com/jpcx/node-kraken-api/blob/0.4.1/CHANGELOG.md). | ||
@@ -520,2 +520,2 @@ ## Contribution | ||
This project is licensed under the MIT License - see the [LICENSE](https://github.com/jpcx/node-kraken-api/blob/0.4.0/LICENSE) file for details | ||
This project is licensed under the MIT License - see the [LICENSE](https://github.com/jpcx/node-kraken-api/blob/0.4.1/LICENSE) file for details |
@@ -7,3 +7,3 @@ { | ||
"repo": "https://github.com/jpcx/node-kraken-api", | ||
"tag": "0.4.0", | ||
"tag": "0.4.1", | ||
"node": "8.7.0", | ||
@@ -10,0 +10,0 @@ "jsdoc": [ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
283268