node-kraken-api
Advanced tools
Comparing version 0.1.0 to 0.1.1
@@ -10,4 +10,4 @@ Module: API/Calls/GenRequestData | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | Execution settings. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~Params) | Object containing call specs. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~Config) | Execution settings. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~Params) | Object containing call specs. | | ||
@@ -17,3 +17,3 @@ | ||
* [node-kraken-api/api/calls/genRequestData.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/genRequestData.js), [line 12](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/genRequestData.js#L12) | ||
* [node-kraken-api/api/calls/genRequestData.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/genRequestData.js), [line 12](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/genRequestData.js#L12) | ||
@@ -26,22 +26,22 @@ ##### Returns: | ||
[API\~Calls~RequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~RequestData) | ||
[API\~Calls~RequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~RequestData) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
@@ -10,4 +10,4 @@ Module: API/Calls/LoadCall | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | Execution settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~Config) | Execution settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
@@ -17,3 +17,3 @@ | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js), [line 235](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js#L235) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js), [line 235](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js#L235) | ||
@@ -26,22 +26,22 @@ ##### Returns: | ||
[API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~Call) | ||
[API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~Call) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
@@ -10,6 +10,6 @@ Module: API/Calls/SignRequest | ||
| --- | --- | --- | | ||
| `secret` | [Kraken~Secret](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Secret) | Kraken API secret key. | | ||
| `nonce` | [Kraken~Nonce](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Nonce) | Kraken API nonce. | | ||
| `post` | [Kraken~HTTPSRequestPOSTData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~HTTPSRequestPOSTData) | POST data. | | ||
| `path` | [Kraken~Path](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Path) | Path to Kraken Method URL. | | ||
| `secret` | [Kraken~Secret](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Secret) | Kraken API secret key. | | ||
| `nonce` | [Kraken~Nonce](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Nonce) | Kraken API nonce. | | ||
| `post` | [Kraken~HTTPSRequestPOSTData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~HTTPSRequestPOSTData) | POST data. | | ||
| `path` | [Kraken~Path](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Path) | Path to Kraken Method URL. | | ||
@@ -19,3 +19,3 @@ | ||
* [node-kraken-api/api/calls/signRequest.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/signRequest.js), [line 11](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/signRequest.js#L11) | ||
* [node-kraken-api/api/calls/signRequest.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/signRequest.js), [line 11](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/signRequest.js#L11) | ||
@@ -28,22 +28,22 @@ ##### Returns: | ||
[API\~Calls~Signature](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~Signature) | ||
[API\~Calls~Signature](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~Signature) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
@@ -10,3 +10,3 @@ Module: API/RateLimits/LoadLimiter | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
@@ -16,3 +16,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js), [line 77](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js#L77) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js), [line 77](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js#L77) | ||
@@ -25,22 +25,22 @@ ##### Returns: | ||
[API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Functions) | ||
[API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Functions) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
@@ -10,5 +10,5 @@ Module: API/Syncing/LoadSync | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | Settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~Call) | Stateful call function. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~Config) | Settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~Call) | Stateful call function. | | ||
@@ -18,3 +18,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 300](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L300) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 300](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L300) | ||
@@ -27,22 +27,22 @@ ##### Returns: | ||
[API\~Syncing~Sync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~Sync) | ||
[API\~Syncing~Sync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~Sync) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
@@ -10,3 +10,3 @@ Module: node-kraken-api | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | User-defined settings. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~Config) | User-defined settings. | | ||
@@ -16,3 +16,3 @@ | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/index.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.1.0/index.js#L14) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/index.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.1.1/index.js#L14) | ||
@@ -33,22 +33,22 @@ ##### Throws: | ||
[API~Functions](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md#~Functions) | ||
[API~Functions](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md#~Functions) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
@@ -10,3 +10,3 @@ Module: Settings/ParseSettings | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | Current supplied custom settings configuration. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~Config) | Current supplied custom settings configuration. | | ||
@@ -16,3 +16,3 @@ | ||
* [node-kraken-api/settings/parseSettings.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/settings/parseSettings.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.1.0/settings/parseSettings.js#L14) | ||
* [node-kraken-api/settings/parseSettings.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/settings/parseSettings.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.1.1/settings/parseSettings.js#L14) | ||
@@ -33,22 +33,22 @@ ##### Throws: | ||
[Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | ||
[Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~Config) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
@@ -15,3 +15,3 @@ Module: Tools/AlphabetizeNested | ||
* [node-kraken-api/tools/alphabetizeNested.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/tools/alphabetizeNested.js), [line 4](https://github.com/jpcx/node-kraken-api/blob/0.1.0/tools/alphabetizeNested.js#L4) | ||
* [node-kraken-api/tools/alphabetizeNested.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/tools/alphabetizeNested.js), [line 4](https://github.com/jpcx/node-kraken-api/blob/0.1.1/tools/alphabetizeNested.js#L4) | ||
@@ -28,18 +28,18 @@ ##### Returns: | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
Module: Tools/ParseNested | ||
========================= | ||
Parses objects based on [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md#~ParseNestedConfig). | ||
Parses objects based on [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md#~ParseNestedConfig). | ||
@@ -10,3 +10,3 @@ ##### Parameters: | ||
| --- | --- | --- | | ||
| `config` | [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md#~ParseNestedConfig) | Parse types config. | | ||
| `config` | [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md#~ParseNestedConfig) | Parse types config. | | ||
| `obj` | Object \| Array \| Map \| Set | Object to parse. | | ||
@@ -17,3 +17,3 @@ | ||
* [node-kraken-api/tools/parseNested.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/tools/parseNested.js), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.1.0/tools/parseNested.js#L13) | ||
* [node-kraken-api/tools/parseNested.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/tools/parseNested.js), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.1.1/tools/parseNested.js#L13) | ||
@@ -30,18 +30,18 @@ ##### Returns: | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.0/api/api.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/api.jsdoc#L7) | ||
* [node-kraken-api/api/api.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/api.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/api.jsdoc#L7) | ||
### Namespaces | ||
[Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
[Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
[RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
[RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
[Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
[Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
@@ -29,3 +29,3 @@ ### Methods | ||
| --- | --- | --- | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~OTP) | New two-factor password. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~OTP) | New two-factor password. | | ||
@@ -35,3 +35,3 @@ | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/index.js), [line 27](https://github.com/jpcx/node-kraken-api/blob/0.1.0/index.js#L27) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/index.js), [line 27](https://github.com/jpcx/node-kraken-api/blob/0.1.1/index.js#L27) | ||
@@ -65,4 +65,4 @@ ##### Throws: | ||
| --- | --- | --- | | ||
| `err` | [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~CallError) | Request errors. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~CallData) | Response data. | | ||
| `err` | [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~CallError) | Request errors. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~CallData) | Response data. | | ||
@@ -72,3 +72,3 @@ | ||
* [node-kraken-api/api/api.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/api.jsdoc), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/api.jsdoc#L13) | ||
* [node-kraken-api/api/api.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/api.jsdoc), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/api.jsdoc#L13) | ||
@@ -88,5 +88,5 @@ <a name="~Functions"></a> | ||
| --- | --- | --- | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~Call) | Call a single method. | | ||
| `sync` | [API\~Syncing~Sync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~Sync) | Create a sync instance. | | ||
| `setOTP` | [API~SetOTP](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md#~SetOTP) | Sets a new two-factor password. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~Call) | Call a single method. | | ||
| `sync` | [API\~Syncing~Sync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~Sync) | Create a sync instance. | | ||
| `setOTP` | [API~SetOTP](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md#~SetOTP) | Sets a new two-factor password. | | ||
@@ -96,22 +96,22 @@ | ||
* [node-kraken-api/api/api.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/api.jsdoc), [line 22](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/api.jsdoc#L22) | ||
* [node-kraken-api/api/api.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/api.jsdoc), [line 22](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/api.jsdoc#L22) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
@@ -1,2 +0,2 @@ | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md)~Calls | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md)~Calls | ||
@@ -9,5 +9,5 @@ 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.1.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.1.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.1.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.1.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.1.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.1.1/docs/modules/API/Calls/SignRequest.md) | Applies a cryptographic signature to a given request. | | ||
@@ -17,3 +17,3 @@ | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L7) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L7) | ||
@@ -31,5 +31,5 @@ ### Methods | ||
| --- | --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Options) | \<optional> | Method-specific options. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Options) | \<optional> | Method-specific options. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md#~Callback) | \<optional> | Optional callback for error or data. | | ||
@@ -39,7 +39,7 @@ | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js), [line 260](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js#L260) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js), [line 260](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js#L260) | ||
##### Throws: | ||
Throws 'Invalid method' if method is not found in [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/Settings.md#~Config). | ||
@@ -67,3 +67,3 @@ Type | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | Instance settings. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.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. | | ||
@@ -74,3 +74,3 @@ | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js#L14) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js#L14) | ||
@@ -94,4 +94,4 @@ ##### Returns: | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | Instance settings. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~Params) | Call parameters. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~Config) | Instance settings. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~Params) | Call parameters. | | ||
@@ -101,3 +101,3 @@ | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js), [line 59](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js#L59) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js), [line 59](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js#L59) | ||
@@ -113,3 +113,3 @@ ##### Returns: | ||
<a name="~ParseArgs"></a> | ||
#### (inner) ParseArgs(settings, method, options, otp, cb) → \{[API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Calls.md#~Arguments)} | ||
@@ -122,7 +122,7 @@ 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.1.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~OTP) | Two-factor password. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md#~Callback) | Listener for errors and data. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~OTP) | Two-factor password. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md#~Callback) | Listener for errors and data. | | ||
@@ -132,3 +132,3 @@ | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js), [line 177](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js#L177) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js), [line 177](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js#L177) | ||
@@ -149,3 +149,3 @@ ##### Throws: | ||
[API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~Arguments) | ||
[API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~Arguments) | ||
@@ -161,7 +161,7 @@ <a name="~ProcessCalls"></a> | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | Execution settings configuraiton. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Category) | Rate-limit category. | | ||
| `thread` | [API\~Calls~Thread](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.0/docs/namespaces/API/RateLimits.md#~Functions) | Rate-limit handler. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~Config) | Execution settings configuraiton. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Category) | Rate-limit category. | | ||
| `thread` | [API\~Calls~Thread](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.1/docs/namespaces/API/RateLimits.md#~Functions) | Rate-limit handler. | | ||
@@ -171,3 +171,3 @@ | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js), [line 89](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js#L89) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js), [line 89](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js#L89) | ||
@@ -185,3 +185,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.1.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.1.1/docs/namespaces/Settings.md#~Config).retryCt. | ||
@@ -192,7 +192,7 @@ ##### Parameters: | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | Execution settings configuraiton. | | ||
| `state` | [API\~Calls~State](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~State) | Current state variables. | | ||
| `args` | [API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~Arguments) | Call-specific arguments. | | ||
| `opListener` | [API\~Calls~OpListener](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.0/docs/namespaces/API.md#~Callback). | | ||
| `retryCt` | [API\~Calls~RetryCount](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/Settings.md#~Config) | Execution settings configuraiton. | | ||
| `state` | [API\~Calls~State](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~State) | Current state variables. | | ||
| `args` | [API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~Arguments) | Call-specific arguments. | | ||
| `opListener` | [API\~Calls~OpListener](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API.md#~Callback). | | ||
| `retryCt` | [API\~Calls~RetryCount](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~RetryCount) | Number of times call has been attempted. | | ||
@@ -202,3 +202,3 @@ | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js), [line 133](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js#L133) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js), [line 133](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js#L133) | ||
@@ -220,5 +220,5 @@ ### Type Definitions | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Method) | Call method. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md#~Callback) | Callback for error or data. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Method) | Call method. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md#~Callback) | Callback for error or data. | | ||
@@ -228,3 +228,3 @@ | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 16](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L16) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 16](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L16) | ||
@@ -242,3 +242,3 @@ <a name="~CallData"></a> | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 51](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L51) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 51](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L51) | ||
@@ -256,3 +256,3 @@ <a name="~CallError"></a> | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 45](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L45) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 45](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L45) | ||
@@ -262,11 +262,11 @@ <a name="~CatThreads"></a> | ||
Holds maps of [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.0/docs/namespaces/API/RateLimits.md#~Category), [API\~Calls~Thread](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~Thread)> | ||
* Map.<[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Category), [API\~Calls~Thread](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~Thread)> | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 101](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L101) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 101](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L101) | ||
@@ -280,7 +280,7 @@ <a name="~ListenerSet"></a> | ||
* Set.<[API\~Calls~RetryListener](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~RetryListener)> | ||
* Set.<[API\~Calls~RetryListener](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~RetryListener)> | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 107](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L107) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 107](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L107) | ||
@@ -296,4 +296,4 @@ <a name="~OpListener"></a> | ||
| --- | --- | --- | | ||
| `err` | Error | Any operational errors or [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~CallError) | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Calls.md#~CallError) | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~CallData) | Data received from call. | | ||
@@ -303,3 +303,3 @@ | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 83](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L83) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 83](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L83) | ||
@@ -319,4 +319,4 @@ <a name="~Params"></a> | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
@@ -326,3 +326,3 @@ | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 57](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L57) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 57](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L57) | ||
@@ -342,4 +342,4 @@ <a name="~RequestData"></a> | ||
| --- | --- | --- | | ||
| `options` | [Kraken~HTTPSRequestOptions](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.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.1.1/docs/namespaces/Kraken.md#~HTTPSRequestPOSTData) | POST data for HTTPS request to Kraken servers. | | ||
@@ -349,3 +349,3 @@ | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L31) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L31) | ||
@@ -363,3 +363,3 @@ <a name="~RetryCount"></a> | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 77](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L77) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 77](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L77) | ||
@@ -369,3 +369,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.1.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.1.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.1.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.1.1/docs/namespaces/API/Calls.md#~OpListener). | ||
@@ -376,4 +376,4 @@ ##### Parameters: | ||
| --- | --- | --- | | ||
| `err` | Error | Any operational errors or [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~CallError) | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Calls.md#~CallError) | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~CallData) | Data received from call. | | ||
@@ -383,3 +383,3 @@ | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 92](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L92) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 92](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L92) | ||
@@ -389,3 +389,3 @@ <a name="~SerialParams"></a> | ||
Alphabetized and serialized [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Calls.md#~Params) used for identifying multiple copies of the same call parameters. | ||
@@ -398,3 +398,3 @@ ##### Type: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 65](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L65) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 65](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L65) | ||
@@ -408,7 +408,7 @@ <a name="~SerialRegistry"></a> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~SerialParams), [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~Params)> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~SerialParams), [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~Params)> | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 71](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L71) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 71](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L71) | ||
@@ -426,3 +426,3 @@ <a name="~Signature"></a> | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 39](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L39) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 39](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L39) | ||
@@ -438,6 +438,6 @@ <a name="~State"></a> | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | Execution settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter object. | | ||
| `catThreads` | [API\~Calls~CatThreads](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~CatThreads) | Category-based execution threads. | | ||
| `serialReg` | [API\~Calls~SerialRegistry](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/Settings.md#~Config) | Execution settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Functions) | Limiter object. | | ||
| `catThreads` | [API\~Calls~CatThreads](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~CatThreads) | Category-based execution threads. | | ||
| `serialReg` | [API\~Calls~SerialRegistry](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~SerialRegistry) | Maps serialized params to actual params. | | ||
@@ -447,3 +447,3 @@ | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js), [line 244](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/loadCall.js#L244) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js), [line 244](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/loadCall.js#L244) | ||
@@ -457,7 +457,7 @@ <a name="~Thread"></a> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~SerialParams), [API\~Calls~ListenerSet](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~ListenerSet)> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~SerialParams), [API\~Calls~ListenerSet](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~ListenerSet)> | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 113](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L113) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 113](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L113) | ||
@@ -475,22 +475,22 @@ <a name="~Timeout"></a> | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/calls/calls.jsdoc#L25) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/calls/calls.jsdoc#L25) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
@@ -1,2 +0,2 @@ | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md)~RateLimits | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md)~RateLimits | ||
@@ -9,3 +9,3 @@ 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.1.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.1.0/docs/namespaces/Kraken.md#~Tier), [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Method), and [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~RateLimiter). | | ||
| `LoadLimiter` | [module:API/RateLimits/LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/Kraken.md#~Tier), [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Method), and [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~RateLimiter). | | ||
@@ -15,3 +15,3 @@ | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/rateLimits.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/rateLimits.jsdoc#L7) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/rateLimits.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/rateLimits.jsdoc#L7) | ||
@@ -29,3 +29,3 @@ ### Methods | ||
| --- | --- | --- | | ||
| `category` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Category) | Type of category based on rate-limiting behavior. | | ||
| `category` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Category) | Type of category based on rate-limiting behavior. | | ||
@@ -35,3 +35,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js), [line 161](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js#L161) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js), [line 161](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js#L161) | ||
@@ -55,3 +55,3 @@ ##### Returns: | ||
| --- | --- | --- | | ||
| `category` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Category) | Type of category based on rate-limiting behavior. | | ||
| `category` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Category) | Type of category based on rate-limiting behavior. | | ||
@@ -61,3 +61,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js), [line 150](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js#L150) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js), [line 150](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js#L150) | ||
@@ -81,3 +81,3 @@ ##### Returns: | ||
| --- | --- | --- | | ||
| `category` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Category) | Type of category based on rate-limiting behavior. | | ||
| `category` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Category) | Type of category based on rate-limiting behavior. | | ||
@@ -87,3 +87,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js), [line 113](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js#L113) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js), [line 113](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js#L113) | ||
@@ -101,3 +101,3 @@ ##### Returns: | ||
Checks the response context for [API\~RateLimits~Update](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/RateLimits.md#~Update) and adjusts call frequency accordingly. | ||
@@ -109,5 +109,5 @@ ##### 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` | [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~RateLimiter) | Rate-limiter settings configuration. | | ||
| `any` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.0/docs/namespaces/API/RateLimits.md#~CatInfo) | Rate information for specific [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Category). | | ||
| `limitConfig` | [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~RateLimiter) | Rate-limiter settings configuration. | | ||
| `any` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/RateLimits.md#~CatInfo) | Rate information for specific [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Category). | | ||
@@ -117,3 +117,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js#L25) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js#L25) | ||
@@ -129,4 +129,4 @@ <a name="~CheckPileUp"></a> | ||
| --- | --- | --- | | ||
| `limitConfig` | [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~RateLimiter) | Current rate-limiter settings configuration. | | ||
| `any` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~CallInfo) | Rate information for all calls. | | ||
| `limitConfig` | [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~RateLimiter) | Current rate-limiter settings configuration. | | ||
| `any` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~CallInfo) | Rate information for all calls. | | ||
@@ -136,3 +136,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js), [line 9](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js#L9) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js), [line 9](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js#L9) | ||
@@ -148,4 +148,4 @@ <a name="~GetAuthRegenIntvl"></a> | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Tier) | Current verification tier. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Tier) | Current verification tier. | | ||
@@ -155,3 +155,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js), [line 188](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js#L188) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js), [line 188](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js#L188) | ||
@@ -167,3 +167,3 @@ ##### Returns: | ||
<a name="~GetCategory"></a> | ||
#### (inner) GetCategory(method) → \{[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Category)} | ||
#### (inner) GetCategory(method) → \{[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Category)} | ||
@@ -176,3 +176,3 @@ Gets the type of server-side rate-limiter category based on the method. | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
@@ -182,3 +182,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js), [line 172](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js#L172) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js), [line 172](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js#L172) | ||
@@ -191,3 +191,3 @@ ##### Returns: | ||
[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Category) | ||
[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Category) | ||
@@ -197,3 +197,3 @@ <a name="~Update"></a> | ||
Updates [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~CallInfo) and [API\~RateLimits~CatInfo](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/RateLimits.md#~CallInfo) and [API\~RateLimits~CatInfo](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~CatInfo) intervals in response to server response behavior. | ||
@@ -204,4 +204,4 @@ ##### Parameters: | ||
| --- | --- | --- | --- | | ||
| `state` | [API\~RateLimits~State](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~State) | | Stateful registry of limiter information. | | ||
| `category` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Category) | | Type of category based on rate-limiting behavior. | | ||
| `state` | [API\~RateLimits~State](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~State) | | Stateful registry of limiter information. | | ||
| `category` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Category) | | Type of category based on rate-limiting behavior. | | ||
| `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. | | ||
@@ -212,3 +212,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js), [line 46](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js#L46) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js), [line 46](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js#L46) | ||
@@ -237,3 +237,3 @@ ### Type Definitions | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/rateLimits.jsdoc), [line 20](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/rateLimits.jsdoc#L20) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/rateLimits.jsdoc), [line 20](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/rateLimits.jsdoc#L20) | ||
@@ -251,3 +251,3 @@ <a name="~Category"></a> | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/rateLimits.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/rateLimits.jsdoc#L14) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/rateLimits.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/rateLimits.jsdoc#L14) | ||
@@ -273,3 +273,3 @@ <a name="~CatInfo"></a> | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/rateLimits.jsdoc), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/rateLimits.jsdoc#L35) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/rateLimits.jsdoc), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/rateLimits.jsdoc#L35) | ||
@@ -289,7 +289,7 @@ <a name="~Functions"></a> | ||
| --- | --- | --- | | ||
| `attempt` | [API\~RateLimits~Attempt](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.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.1.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.1.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.1.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.1.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.1.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.1.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.1.1/docs/namespaces/API/RateLimits.md#~GetAuthRegenIntvl) | Gets the amount of time necessary for a given private method to be called sustainably. | | ||
@@ -299,3 +299,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js), [line 102](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js#L102) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js), [line 102](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js#L102) | ||
@@ -311,5 +311,5 @@ <a name="~State"></a> | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `calls` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.1/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `calls` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/RateLimits.md#~CatInfo) | Map of category to object containing category-specific rate information. | | ||
@@ -319,22 +319,22 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js), [line 85](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/rateLimits/loadLimiter.js#L85) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js), [line 85](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/rateLimits/loadLimiter.js#L85) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
@@ -1,4 +0,4 @@ | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md)~Syncing | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.1/docs/namespaces/API/Calls.md#~Call) operations. | ||
@@ -9,3 +9,3 @@ ##### Properties: | ||
| --- | --- | --- | | ||
| `LoadSync` | [module:API/Syncing/LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/modules/API/Syncing/LoadSync.md) | Loads settings and loaded call function and returns stateful sync creation function. | | ||
@@ -15,3 +15,3 @@ | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc#L7) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc#L7) | ||
@@ -23,3 +23,3 @@ ### Methods | ||
Associates a new [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Syncing.md#~EventListener) with the instance. | ||
@@ -30,3 +30,3 @@ ##### Parameters: | ||
| --- | --- | --- | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~EventListener) | Listener function to add. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~EventListener) | Listener function to add. | | ||
@@ -36,3 +36,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 465](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L465) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 465](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L465) | ||
@@ -50,3 +50,3 @@ ##### Returns: | ||
Calculates average wait time (for sustainable authenticated calling) based on the current open sync requests. Uses [Kraken~CounterLimit](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~CounterLimit), [Kraken~IncrementAmount](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~IncrementAmount), and [Kraken~CounterInterval](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~CounterInterval) to determine the minimum sustainable wait time. See the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) for more information. | ||
Calculates average wait time (for sustainable authenticated calling) based on the current open sync requests. Uses [Kraken~CounterLimit](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~CounterLimit), [Kraken~IncrementAmount](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~IncrementAmount), and [Kraken~CounterInterval](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~CounterInterval) to determine the minimum sustainable wait time. See the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) for more information. | ||
@@ -57,3 +57,3 @@ ##### Parameters: | ||
| --- | --- | --- | | ||
| `state` | [API\~Syncing~State](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
| `state` | [API\~Syncing~State](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
@@ -63,3 +63,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 11](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L11) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 11](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L11) | ||
@@ -81,3 +81,3 @@ ##### Returns: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 438](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L438) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 438](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L438) | ||
@@ -95,3 +95,3 @@ ##### Returns: | ||
Handles request queue and sends data to associated [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Syncing.md#~EventListener)s. | ||
@@ -102,4 +102,4 @@ ##### Parameters: | ||
| --- | --- | --- | | ||
| `state` | [API\~Syncing~State](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Category) | Current rate-limit category. | | ||
| `state` | [API\~Syncing~State](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Category) | Current rate-limit category. | | ||
@@ -109,3 +109,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 156](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L156) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 156](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L156) | ||
@@ -123,3 +123,3 @@ ##### Returns: | ||
Adds a one-time [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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. | ||
@@ -130,3 +130,3 @@ ##### Parameters: | ||
| --- | --- | --- | --- | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Syncing.md#~EventListener) | \<optional> | Once listener function to add. | | ||
@@ -136,3 +136,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 490](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L490) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 490](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L490) | ||
@@ -154,3 +154,3 @@ ##### Returns: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 394](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L394) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 394](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L394) | ||
@@ -166,3 +166,3 @@ ##### Returns: | ||
<a name="~ParseArgs"></a> | ||
#### (inner) ParseArgs(settings, method, options, interval, listener) → \{[API\~Syncing~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Syncing.md#~Arguments)} | ||
@@ -175,7 +175,7 @@ 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.1.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~EventListener) | Listener for errors and data. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~EventListener) | Listener for errors and data. | | ||
@@ -185,3 +185,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 229](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L229) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 229](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L229) | ||
@@ -202,3 +202,3 @@ ##### Throws: | ||
[API\~Syncing~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~Arguments) | ||
[API\~Syncing~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~Arguments) | ||
@@ -208,7 +208,7 @@ <a name="~RemoveAllListeners"></a> | ||
Removes all [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~EventListener)s from the instance. | ||
Removes all [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~EventListener)s from the instance. | ||
Source: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 481](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L481) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 481](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L481) | ||
@@ -226,3 +226,3 @@ ##### Returns: | ||
Disassociates an [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~EventListener) from the instance. | ||
Disassociates an [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~EventListener) from the instance. | ||
@@ -233,3 +233,3 @@ ##### Parameters: | ||
| --- | --- | --- | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~EventListener) | Listener function to remove. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~EventListener) | Listener function to remove. | | ||
@@ -239,3 +239,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 473](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L473) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 473](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L473) | ||
@@ -251,3 +251,3 @@ ##### Returns: | ||
<a name="~Sync"></a> | ||
#### (inner) Sync(method, optionsopt, intervalopt, listeneropt) → \{[API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Syncing.md#~Instance)} | ||
@@ -260,6 +260,6 @@ 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.1.0/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Options) | \<optional> | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.1/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Options) | \<optional> | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Syncing.md#~EventListener) | \<optional> | Listener for error and data events. | | ||
@@ -269,3 +269,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 327](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L327) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 327](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L327) | ||
@@ -286,3 +286,3 @@ ##### Throws: | ||
[API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~Instance) | ||
[API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~Instance) | ||
@@ -298,6 +298,6 @@ <a name="~VerifyInternals"></a> | ||
| --- | --- | --- | | ||
| `state` | [API\~Syncing~State](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.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.1.1/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.1/docs/namespaces/API/Syncing.md#~InternalSet) | Set of all internals associated with the current thread. | | ||
@@ -307,3 +307,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L35) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L35) | ||
@@ -325,5 +325,5 @@ ### Type Definitions | ||
| --- | --- | --- | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~EventListener) | Event listener for sync error and data events. | | ||
@@ -333,3 +333,3 @@ | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc#L14) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc#L14) | ||
@@ -339,11 +339,11 @@ <a name="~CatThreads"></a> | ||
Holds maps of [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.0/docs/namespaces/API/RateLimits.md#~Category), [API\~Syncing~Thread](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~Thread)> | ||
* Map.<[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Category), [API\~Syncing~Thread](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~Thread)> | ||
Source: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc), [line 58](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc#L58) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc), [line 58](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc#L58) | ||
@@ -353,3 +353,3 @@ <a name="~Error"></a> | ||
Timestamped [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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. | ||
@@ -369,3 +369,3 @@ ##### Type: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc), [line 51](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc#L51) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc), [line 51](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc#L51) | ||
@@ -375,3 +375,3 @@ <a name="~EventListener"></a> | ||
Callback function that is executed upon sync errors or data events. Returning a truthy value from this function will instruct the sync operation to not assign the 'data' property of the [API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~Instance). In other words, returning a truthy value will inform the sync process that data will either be reassigned from within this event listener manually or does not need to be set. | ||
Callback function that is executed upon sync errors or data events. Returning a truthy value from this function will instruct the sync operation to not assign the 'data' property of the [API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~Instance). In other words, returning a truthy value will inform the sync process that data will either be reassigned from within this event listener manually or does not need to be set. | ||
@@ -382,5 +382,5 @@ ##### Parameters: | ||
| --- | --- | --- | --- | | ||
| `err` | [API\~Syncing~Error](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~Error) | | Sync error. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~CallData) | | Data received from call. | | ||
| `instance` | [API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Syncing.md#~Error) | | Sync error. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~CallData) | | Data received from call. | | ||
| `instance` | [API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~Instance) | \<optional> | Reference to the current instance, if necessary. | | ||
@@ -390,3 +390,3 @@ | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc), [line 41](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc#L41) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc), [line 41](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc#L41) | ||
@@ -414,14 +414,14 @@ ##### Returns: | ||
| --- | --- | --- | | ||
| `status` | [API\~Syncing~Status](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update time. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.0/docs/namespaces/API/Syncing.md#~InstanceData) | Object containing data from the last successful response. | | ||
| `open` | [API\~Syncing~Open](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.0/docs/namespaces/API/Syncing.md#~AddListener) | Associates a new [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~EventListener). | | ||
| `removeListener` | [API\~Syncing~RemoveListener](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~RemoveListener) | Disassociates a [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~EventListener). | | ||
| `removeAllListeners` | [API\~Syncing~RemoveAllListeners](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~RemoveAllListeners) | Removes all associated [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~EventListener)s. | | ||
| `once` | [API\~Syncing~Once](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~Once) | Adds a one-time [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~EventListener) if provided; otherwise returns a promise which resolves/rejects on the next error/data event. | | ||
| `time` | number | Time (in ms) of last successful [API\~Syncing~InstanceData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~InstanceData) update. | | ||
| `status` | [API\~Syncing~Status](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update time. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.1/docs/namespaces/API/Syncing.md#~InstanceData) | Object containing data from the last successful response. | | ||
| `open` | [API\~Syncing~Open](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.1/docs/namespaces/API/Syncing.md#~AddListener) | Associates a new [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~EventListener). | | ||
| `removeListener` | [API\~Syncing~RemoveListener](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~RemoveListener) | Disassociates a [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~EventListener). | | ||
| `removeAllListeners` | [API\~Syncing~RemoveAllListeners](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~RemoveAllListeners) | Removes all associated [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~EventListener)s. | | ||
| `once` | [API\~Syncing~Once](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~Once) | Adds a one-time [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~EventListener) if provided; otherwise returns a promise which resolves/rejects on the next error/data event. | | ||
| `time` | number | Time (in ms) of last successful [API\~Syncing~InstanceData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~InstanceData) update. | | ||
@@ -431,3 +431,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 348](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L348) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 348](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L348) | ||
@@ -437,3 +437,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.1.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.1.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.1.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.1.1/docs/namespaces/API/Syncing.md#~EventListener) or otherwise. | ||
@@ -446,3 +446,3 @@ ##### Type: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc), [line 23](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc#L23) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc), [line 23](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc#L23) | ||
@@ -462,9 +462,9 @@ <a name="~Internal"></a> | ||
| --- | --- | --- | | ||
| `status` | [API\~Syncing~Status](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.0/docs/namespaces/API/Syncing.md#~Instance) | Instance being tracked. | | ||
| `listeners` | Set.<[API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~EventListener)> | Set of all associated event listeners. | | ||
| `data` | [API\~Syncing~InstanceData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~InstanceData) | Object containing data from the last successful response. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Syncing.md#~Instance) | Instance being tracked. | | ||
| `listeners` | Set.<[API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~EventListener)> | Set of all associated event listeners. | | ||
| `data` | [API\~Syncing~InstanceData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~InstanceData) | Object containing data from the last successful response. | | ||
@@ -474,3 +474,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 367](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L367) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 367](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L367) | ||
@@ -484,7 +484,7 @@ <a name="~InternalSet"></a> | ||
* Set.<[API\~Syncing~Internal](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~Internal)> | ||
* Set.<[API\~Syncing~Internal](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~Internal)> | ||
Source: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc), [line 70](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc#L70) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc), [line 70](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc#L70) | ||
@@ -502,3 +502,3 @@ <a name="~Interval"></a> | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc#L35) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc#L35) | ||
@@ -518,7 +518,7 @@ <a name="~State"></a> | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | Settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~Call) | Stateful call function. | | ||
| `catThreads` | [API\~Syncing~CatThreads](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.1/docs/namespaces/Settings.md#~Config) | Settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~Call) | Stateful call function. | | ||
| `catThreads` | [API\~Syncing~CatThreads](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/API/Calls.md#~SerialRegistry) | Maps serialized params to actual params. | | ||
@@ -528,3 +528,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js), [line 310](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/loadSync.js#L310) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js), [line 310](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/loadSync.js#L310) | ||
@@ -534,3 +534,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.1.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.1.1/docs/namespaces/API/Calls.md#~CallData) has not been received; 'open' if queued; 'closed' if not queued. | ||
@@ -543,3 +543,3 @@ ##### Type: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc), [line 29](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc#L29) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc), [line 29](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc#L29) | ||
@@ -553,26 +553,26 @@ <a name="~Thread"></a> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md#~SerialParams), [API\~Syncing~InternalSet](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md#~InternalSet)> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~SerialParams), [API\~Syncing~InternalSet](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md#~InternalSet)> | ||
Source: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc), [line 64](https://github.com/jpcx/node-kraken-api/blob/0.1.0/api/syncing/syncing.jsdoc#L64) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc), [line 64](https://github.com/jpcx/node-kraken-api/blob/0.1.1/api/syncing/syncing.jsdoc#L64) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.0/kraken/kraken.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L7) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L7) | ||
@@ -15,3 +15,3 @@ ### Type Definitions | ||
Number of seconds for the [Kraken~RateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~RateLimitCount) to decrement by one. Depends on the [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.1.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~RateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~RateLimitCount) to decrement by one. Depends on the [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Tier). See the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) for more information. | ||
@@ -24,3 +24,3 @@ ##### Type: | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 134](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L134) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 134](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L134) | ||
@@ -30,11 +30,11 @@ <a name="~CounterLimit"></a> | ||
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.1.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.1.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~RateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~RateLimitCount) | ||
* [Kraken~RateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~RateLimitCount) | ||
Source: | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 122](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L122) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 122](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L122) | ||
@@ -52,3 +52,3 @@ <a name="~Hostname"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 80](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L80) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 80](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L80) | ||
@@ -68,4 +68,4 @@ <a name="~HTTPSRequestHeaders"></a> | ||
| --- | --- | --- | | ||
| `API-Key` | [Kraken~Key](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Key) | Kraken API key. | | ||
| `API-Sign` | [API\~Calls~Signature](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/Kraken.md#~Key) | Kraken API key. | | ||
| `API-Sign` | [API\~Calls~Signature](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md#~Signature) | Cryptographic signature using API secret and other call parameters. | | ||
@@ -75,3 +75,3 @@ | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 92](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L92) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 92](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L92) | ||
@@ -91,6 +91,6 @@ <a name="~HTTPSRequestOptions"></a> | ||
| --- | --- | --- | | ||
| `hostname` | [Kraken~Hostname](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Hostname) | Kraken hostname. | | ||
| `path` | [Kraken~Path](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.0/docs/namespaces/Kraken.md#~Method) for the request. | | ||
| `headers` | [Kraken~HTTPSRequestHeaders](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~HTTPSRequestHeaders) | Kraken HTTPS request headers. | | ||
| `hostname` | [Kraken~Hostname](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Hostname) | Kraken hostname. | | ||
| `path` | [Kraken~Path](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/Kraken.md#~Method) for the request. | | ||
| `headers` | [Kraken~HTTPSRequestHeaders](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~HTTPSRequestHeaders) | Kraken HTTPS request headers. | | ||
@@ -100,3 +100,3 @@ | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 100](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L100) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 100](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L100) | ||
@@ -114,3 +114,3 @@ <a name="~HTTPSRequestPOSTData"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 110](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L110) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 110](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L110) | ||
@@ -120,11 +120,11 @@ <a name="~IncrementAmount"></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.1.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.1.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~RateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~RateLimitCount) | ||
* [Kraken~RateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~RateLimitCount) | ||
Source: | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 128](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L128) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 128](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L128) | ||
@@ -142,3 +142,3 @@ <a name="~Key"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L13) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L13) | ||
@@ -156,3 +156,3 @@ <a name="~Method"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 55](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L55) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 55](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L55) | ||
@@ -170,3 +170,3 @@ <a name="~Nonce"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 74](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L74) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 74](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L74) | ||
@@ -184,3 +184,3 @@ <a name="~Option"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 61](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L61) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 61](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L61) | ||
@@ -200,3 +200,3 @@ <a name="~Options"></a> | ||
| --- | --- | --- | | ||
| `*` | [Kraken~Option](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Option) | An option to send to the servers. | | ||
| `*` | [Kraken~Option](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Option) | An option to send to the servers. | | ||
@@ -206,3 +206,3 @@ | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 67](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L67) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 67](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L67) | ||
@@ -220,3 +220,3 @@ <a name="~OTP"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L31) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L31) | ||
@@ -234,3 +234,3 @@ <a name="~Path"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 86](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L86) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 86](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L86) | ||
@@ -248,3 +248,3 @@ <a name="~PrivateMethods"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 49](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L49) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 49](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L49) | ||
@@ -262,3 +262,3 @@ <a name="~PublicMethods"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 43](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L43) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 43](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L43) | ||
@@ -276,3 +276,3 @@ <a name="~RateLimitCount"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 116](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L116) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 116](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L116) | ||
@@ -290,3 +290,3 @@ <a name="~Secret"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 19](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L19) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 19](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L19) | ||
@@ -304,3 +304,3 @@ <a name="~Tier"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L25) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L25) | ||
@@ -318,22 +318,22 @@ <a name="~Version"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc), [line 37](https://github.com/jpcx/node-kraken-api/blob/0.1.0/kraken/kraken.jsdoc#L37) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc), [line 37](https://github.com/jpcx/node-kraken-api/blob/0.1.1/kraken/kraken.jsdoc#L37) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
@@ -9,3 +9,3 @@ # Settings | ||
| --- | --- | --- | | ||
| `ParseSettings` | [module:Settings/ParseSettings](module-Settings_Parsehttps://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/Settings.md) | Parses user-provided settings, throws errors if necessary, and combines with defaults. | | ||
@@ -15,3 +15,3 @@ | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/settings/settings.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.0/settings/settings.jsdoc#L7) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/settings/settings.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.1/settings/settings.jsdoc#L7) | ||
@@ -33,15 +33,15 @@ ### Type Definitions | ||
| --- | --- | --- | --- | --- | | ||
| `key` | [Kraken~Key](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Key) | \<optional> | '' | API key. | | ||
| `secret` | [Kraken~Secret](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Secret) | \<optional> | '' | API secret. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~Tier) | \<optional> | 0 | Verification tier. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md#~OTP) | \<optional> | null | Two factor password. | | ||
| `timeout` | [API\~Calls~Timeout](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.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.1.0/docs/namespaces/Kraken.md#~Version) | \<optional> | 0 | Kraken API version. | | ||
| `pubMethods` | [Kraken~PublicMethods](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.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.1.0/docs/namespaces/Settings.md#~RateLimiter) | \<optional> | { baseIntvl: 500, minIntvl: 250, pileUpWindow: 60000, pileUpThreshold: 5, pileUpResetIntvl: 1000, pileUpMultiplier: 1.05, violationResetIntvl: 4500, violationMultiplier: 1.1, anyPassDecay: 0.95, specificPassDecay: 0.95 } | Settings for call interval limitations. | | ||
| `syncIntervals` | [Settings~SyncIntervals](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~SyncIntervals) | \<optional> | { OHLC: 60000, Trades: 600 } | | | ||
| `key` | [Kraken~Key](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Key) | \<optional> | '' | API key. | | ||
| `secret` | [Kraken~Secret](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Secret) | \<optional> | '' | API secret. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~Tier) | \<optional> | 0 | Verification tier. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md#~OTP) | \<optional> | null | Two factor password. | | ||
| `timeout` | [API\~Calls~Timeout](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.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.1.1/docs/namespaces/Kraken.md#~Version) | \<optional> | 0 | Kraken API version. | | ||
| `pubMethods` | [Kraken~PublicMethods](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.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.1.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.1.1/docs/namespaces/Settings.md#~RateLimiter) | \<optional> | { baseIntvl: 500, minIntvl: 250, pileUpWindow: 60000, pileUpThreshold: 5, pileUpResetIntvl: 1000, pileUpMultiplier: 1.05, violationResetIntvl: 4500, violationMultiplier: 1.1, anyPassDecay: 0.95, specificPassDecay: 0.95 } | Settings for call interval limitations. | | ||
| `syncIntervals` | [Settings~SyncIntervals](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~SyncIntervals) | \<optional> | { OHLC: 60000, Trades: 600 } | | | ||
@@ -51,3 +51,3 @@ | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/settings/settings.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.1.0/settings/settings.jsdoc#L14) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/settings/settings.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.1.1/settings/settings.jsdoc#L14) | ||
@@ -81,3 +81,3 @@ <a name="~RateLimiter"></a> | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/settings/settings.jsdoc), [line 33](https://github.com/jpcx/node-kraken-api/blob/0.1.0/settings/settings.jsdoc#L33) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/settings/settings.jsdoc), [line 33](https://github.com/jpcx/node-kraken-api/blob/0.1.1/settings/settings.jsdoc#L33) | ||
@@ -97,3 +97,3 @@ <a name="~SyncIntervals"></a> | ||
| --- | --- | --- | | ||
| `*` | number | Name of [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/Kraken.md#~Method) and default interval (in ms). | | ||
@@ -103,22 +103,22 @@ | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/settings/settings.jsdoc), [line 49](https://github.com/jpcx/node-kraken-api/blob/0.1.0/settings/settings.jsdoc#L49) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/settings/settings.jsdoc), [line 49](https://github.com/jpcx/node-kraken-api/blob/0.1.1/settings/settings.jsdoc#L49) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
@@ -9,4 +9,4 @@ # Tools | ||
| --- | --- | --- | | ||
| `AlphabetizeNested` | [module:Tools/AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | Alphabetizes a nested Object. | | ||
| `ParseNested` | [module:Tools/ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/modules/Tools/AlphabetizeNested.md) | Alphabetizes a nested Object. | | ||
| `ParseNested` | [module:Tools/ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | Parses a nested Object, Array, Map, or Set according to the rules defined in Settings~Parse | | ||
@@ -16,3 +16,3 @@ | ||
* [node-kraken-api/tools/tools.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/tools/tools.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.0/tools/tools.jsdoc#L7) | ||
* [node-kraken-api/tools/tools.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/tools/tools.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.1.1/tools/tools.jsdoc#L7) | ||
@@ -38,22 +38,22 @@ ### Type Definitions | ||
* [node-kraken-api/tools/tools.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.0/tools/tools.jsdoc), [line 15](https://github.com/jpcx/node-kraken-api/blob/0.1.0/tools/tools.jsdoc#L15) | ||
* [node-kraken-api/tools/tools.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.1.1/tools/tools.jsdoc), [line 15](https://github.com/jpcx/node-kraken-api/blob/0.1.1/tools/tools.jsdoc#L15) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.1.1/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) |
{ | ||
"name": "node-kraken-api", | ||
"version": "0.1.0", | ||
"version": "0.1.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": { |
142
README.md
@@ -31,6 +31,6 @@ # node-kraken-api | ||
__Creating an auth.json file for authenticated testing:__ | ||
___Creating an auth.json file for authenticated testing:___ | ||
_NOTE: replace 'nano' with your preferred editor_ | ||
_NOTE: use a read-only key to be safe_ | ||
___NOTE:___ replace 'nano' with your preferred editor | ||
___NOTE:___ use a read-only key to be safe | ||
```console | ||
@@ -40,3 +40,3 @@ nano /path/to/node_modules/node-kraken-api/auth.json | ||
__Installing the jest library:__ | ||
___Installing the jest library:___ | ||
```console | ||
@@ -46,3 +46,3 @@ npm i --prefix /path/to/node_modules/node-kraken-api jest | ||
__Running the testing scripts:__ | ||
___Running the testing scripts:___ | ||
@@ -55,3 +55,3 @@ ```console | ||
__Loading the module:__ | ||
___Loading the module:___ | ||
```js | ||
@@ -61,3 +61,3 @@ const kraken = require('node-kraken-api') | ||
__Public client instantiation:__ | ||
___Public client instantiation:___ | ||
```js | ||
@@ -67,5 +67,9 @@ const api = kraken() | ||
__Private client instantiation (with authenticated [configuration](#configuration)):__ | ||
___Private client instantiation (with authenticated [configuration](#configuration)):___ | ||
```js | ||
const api = kraken({ key: '****', secret: '****', tier: '****' }) | ||
const api = kraken({ | ||
key: '****', | ||
secret: '****', | ||
tier: '****' | ||
}) | ||
``` | ||
@@ -75,8 +79,5 @@ | ||
___NOTE:___ In this example, OTP is set during instantiation. This is advisable only if the two-factor password for this API key is static. Otherwise, use [api.setOTP().](#setOTP) | ||
```js | ||
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * | ||
* Note: In this example, OTP is set during instantiation. * | ||
* This is advisable only if the two-factor password for * | ||
* this API key is static. Otherwise, use api.setOTP() * | ||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | ||
const api = kraken({ | ||
@@ -90,3 +91,3 @@ key: '****', | ||
__Instantiation with any number of configuration settings (see [configuration](#configuration)):__ | ||
___Instantiation with any number of configuration settings (see [configuration](#configuration)):___ | ||
```js | ||
@@ -109,5 +110,5 @@ const api = kraken(require('./config.json')) | ||
__Making a single call:__ | ||
#### Making a single call: | ||
_Using promises:_ | ||
___Using promises:___ | ||
```js | ||
@@ -119,3 +120,3 @@ api.call('Time') | ||
_Using callbacks:_ | ||
___Using callbacks:___ | ||
```js | ||
@@ -128,3 +129,3 @@ api.call('Time', (err, data) => { | ||
_Using promises (with Kraken method options):_ | ||
___Using promises (with Kraken method options):___ | ||
```js | ||
@@ -136,3 +137,3 @@ api.call('Depth', { pair: 'XXBTZUSD', count: 1 }) | ||
_Using callbacks (with Kraken method options):_ | ||
___Using callbacks (with Kraken method options):___ | ||
```js | ||
@@ -147,16 +148,11 @@ api.call('Depth', { pair: 'XXBTZUSD', count: 1 }, | ||
_Using a one-time password (if enabled):_ | ||
___Using a one-time password (if enabled):___ | ||
<a name='setOTP'></a> | ||
___NOTE:___ due to call queueing functionality and rate limiting, OTP may need to be set again if the call has not been executed before the password decays. This shouldn't be a problem unless there have been a very large volume of calls sent to the queue. | ||
Additionally, depending on settings.retryCt, calls with errors will be re-queued. | ||
As such, it is best to continuously call setOTP with each new password until an error or response has been received. | ||
```js | ||
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * | ||
* NOTE: due to call queueing functionality and rate limiting, * | ||
* OTP may need to be set again if the call has not been executed * | ||
* before the password decays. This shouldn't be a problem unless * | ||
* there have been a very large volume of calls sent to the queue. * | ||
* * | ||
* Additionally, depending on settings.retryCt, calls with errors * | ||
* will be re-queued. * | ||
* * | ||
* As such, it is best to continuously call setOTP with each new * | ||
* password until an error or response has been received. * | ||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | ||
api.setOTP(158133) | ||
@@ -173,5 +169,5 @@ | ||
<a name='syncing'></a> | ||
__Working with data syncing:__ | ||
#### Working with data syncing: | ||
_Creating a sync object:_ | ||
___Creating a sync object:___ | ||
```js | ||
@@ -187,3 +183,3 @@ const timeSync = api.sync('Time') | ||
_Creating a sync object with a custom update interval:_ | ||
___Creating a sync object with a custom update interval:___ | ||
```js | ||
@@ -200,3 +196,3 @@ // updates every second | ||
_Using syncing promises:_ | ||
___Using syncing promises:___ | ||
```js | ||
@@ -220,3 +216,3 @@ const api = require('./')() | ||
_Creating a sync object (using a listener callback):_ | ||
___Creating a sync object (using a listener callback):___ | ||
```js | ||
@@ -231,3 +227,3 @@ const timeSync = api.sync('Time', | ||
_Adding a listener callback after creation:_ | ||
___Adding a listener callback after creation:___ | ||
```js | ||
@@ -241,3 +237,3 @@ const timeSync = api.sync('Time') | ||
_Adding a once listener via Promises:_ | ||
___Adding a once listener via Promises:___ | ||
```js | ||
@@ -250,3 +246,3 @@ const timeSync = api.sync('Time') | ||
_Adding a once listener callback:_ | ||
___Adding a once listener callback:___ | ||
```js | ||
@@ -260,3 +256,3 @@ const timeSync = api.sync('Time') | ||
_Closing a sync operation:_ | ||
___Closing a sync operation:___ | ||
```js | ||
@@ -274,3 +270,3 @@ const timeSync = api.sync('Time') | ||
_Re-opening a sync operation:_ | ||
___Re-opening a sync operation:___ | ||
```js | ||
@@ -290,3 +286,3 @@ const timeSync = api.sync('Time') | ||
_Removing a sync listener callback:_ | ||
___Removing a sync listener callback:___ | ||
```js | ||
@@ -304,3 +300,4 @@ const timeSync = api.sync('Time') | ||
<a name='syncUpdates'></a>__Updating Instance Options__ | ||
<a name='syncUpdates'></a> | ||
#### Updating Instance Options | ||
@@ -310,3 +307,3 @@ Using a listener within a sync instance may be used for tracking new data only. | ||
_Logging new trades only:_ | ||
___Logging new trades only:___ | ||
```js | ||
@@ -328,7 +325,8 @@ const tradesSync = api.sync( | ||
<a name='syncInstanceMods'></a>__Custom Handling of Sync Data__ | ||
<a name='syncInstanceMods'></a> | ||
#### Custom Handling of Sync Data | ||
Sync object data may be custom tailored for various use cases by using an event listener. Event listeners are provided with a reference to the instance, so they can be defined to transform received data in any way and store it within a custom property. | ||
_Creating a realtime historical trades tracker:_ | ||
___Creating a realtime historical trades tracker:___ | ||
```js | ||
@@ -358,5 +356,5 @@ const tradesHistory = api.sync( | ||
_Creating a realtime simple moving average (with safe float operations):_ | ||
___Creating a realtime simple moving average (with safe float operations):___ | ||
___NOTE:___ _OHLC calls are set to a 60s sync interval by default. This may be changed either in the settings configuration, during instance creation, or by changing the instance's <code>interval</code> property._ | ||
___NOTE:___ OHLC calls are set to a 60s sync interval by default. This may be changed either in the settings configuration, during instance creation, or by changing the instance's <code>interval</code> property. | ||
@@ -404,3 +402,3 @@ ```js | ||
Configuration specifications are detailed in the documentation [here](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md#~Config) | ||
Configuration specifications are detailed in the documentation [here](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md#~Config) | ||
@@ -413,3 +411,3 @@ ## Documentation | ||
Alternatively, refer to the [default settings](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/docs/namespaces/Settings.md#~Config) in the node-kraken-api documentation. Default method types are listed here (under the 'pubMethods' and 'privMethods' properties). | ||
@@ -428,18 +426,18 @@ Method options are found under the 'Input:' section. For example, 'Get order book' lists the following: | ||
### Internal: | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.0/docs/namespaces/Kraken.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.1.1/docs/namespaces/Kraken.md) | ||
@@ -449,3 +447,3 @@ | ||
Versioned using [SemVer](http://semver.org/). For available versions, see the [Changelog](https://github.com/jpcx/node-kraken-api/blob/0.1.0/CHANGELOG.md). | ||
Versioned using [SemVer](http://semver.org/). For available versions, see the [Changelog](https://github.com/jpcx/node-kraken-api/blob/0.1.1/CHANGELOG.md). | ||
@@ -464,8 +462,8 @@ ## Contribution | ||
3KZw9KTCo3T5MksE7byasq3J8btmLt5BTz | ||
bc1qla9wynkvmnmcnygls5snqeu3rj5dxr7tunwzp6 | ||
![donate](http://i68.tinypic.com/v7f6v9.jpg) | ||
![donate](http://i65.tinypic.com/2414is4.jpg) | ||
## License | ||
This project is licensed under the MIT License - see the [LICENSE](https://github.com/jpcx/node-kraken-api/blob/0.1.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.1.1/LICENSE) file for details |
@@ -7,3 +7,3 @@ { | ||
"repo": "https://github.com/jpcx/node-kraken-api", | ||
"tag": "0.1.0", | ||
"tag": "0.1.1", | ||
"node": "8.7.0", | ||
@@ -10,0 +10,0 @@ "jsdoc": [ |
Sorry, the diff of this file is not supported yet
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
255429
437