node-kraken-api
Advanced tools
Comparing version 0.2.0 to 0.3.0
@@ -104,5 +104,5 @@ /** | ||
const params = { ...serialReg.get(serial) } | ||
await limiter.attempt(cat) | ||
await limiter.attempt(params.method) | ||
if (!thread.has(serial) || thread.get(serial).size === 0) { | ||
limiter.addPass(cat) | ||
limiter.addPass(params.method) | ||
continue | ||
@@ -113,3 +113,3 @@ } | ||
data => { | ||
limiter.addPass(cat) | ||
limiter.addPass(params.method) | ||
if (typeof settings.dataFormatter === 'function') { | ||
@@ -123,4 +123,4 @@ data = settings.dataFormatter(params.method, params.options, data) | ||
if (err.message.match(/rate limit/gi)) { | ||
limiter.addFail(cat) | ||
} else limiter.addPass(cat) | ||
limiter.addFail(params.method) | ||
} else limiter.addPass(params.method) | ||
@@ -127,0 +127,0 @@ listenersCopy.forEach(listener => listener(err, null)) |
@@ -10,2 +10,48 @@ /** | ||
/** | ||
* Returns the amount of counter incrementation based on the method. | ||
* | ||
* @function API~RateLimits~GetAuthIncrementAmt | ||
* @param {Kraken~Method} method - Method being called. | ||
* @returns {Kraken~AuthIncrementAmount} Amount to increment the auth counter. | ||
*/ | ||
const getAuthIncrementAmt = method => | ||
method === 'Ledgers' || method === 'TradesHistory' | ||
? 2 | ||
: method === 'AddOrder' || method === 'CancelOrder' ? 0 : 1 | ||
/** | ||
* Returns the amount of time required to decrement the auth counter. | ||
* | ||
* @function API~RateLimits~GetAuthDecrementInterval | ||
* @param {Kraken~Tier} tier - Kraken verification tier. | ||
* @returns {Kraken~AuthDecrementInterval} Amount of time required to decrement the counter. | ||
*/ | ||
const getAuthDecrementInterval = tier => | ||
tier === 4 ? 1000 : tier === 3 ? 2000 : 3000 | ||
/** | ||
* Returns the maximum counter value for authenticated methods. | ||
* | ||
* @function API~RateLimits~GetAuthCounterLimit | ||
* @param {Kraken~Tier} tier - Kraken verification tier. | ||
* @returns {Kraken~AuthCounterLimit} Maximum count for auth counter. | ||
*/ | ||
const getAuthCounterLimit = tier => (tier >= 3 ? 20 : 15) | ||
/** | ||
* Returns the rate-limit category for a given method. Different categories follow different server-side limiting behavior. | ||
* | ||
* @function API~RateLimits~GetRLCategory | ||
* @param {Kraken~PrivateMethods} privMethods - List of all available private methods. | ||
* @param {Kraken~Method} method - Method being called. | ||
* @returns {API~RateLimits~Category} Rate-limiting category. | ||
*/ | ||
const getRLCategory = (privMethods, method) => | ||
method === 'OHLC' | ||
? 'ohlc' | ||
: method === 'Trades' | ||
? 'trades' | ||
: privMethods.includes(method) ? 'auth' : 'other' | ||
/** | ||
* Checks for more calls being made than responses received and adjusts call frequency accordingly. | ||
@@ -51,12 +97,13 @@ * | ||
* @function API~RateLimits~Update | ||
* @param {API~RateLimits~State} state - Stateful registry of limiter information. | ||
* @param {API~RateLimits~Category} category - Type of category based on rate-limiting behavior. | ||
* @param {('pass'|'fail')} [context] - Reason for invocation; may be called in response to a successful call, a rate limit violation, or a pre-response call attempt. | ||
* @param {API~RateLimits~State} state - Stateful registry of limiter information. | ||
* @param {Kraken~Method} method - Method being called. | ||
* @param {('pass'|'fail')} [context] - Reason for invocation; may be called in response to a successful call, a rate limit violation, or a pre-response call attempt. | ||
*/ | ||
const update = (state, category, context) => { | ||
const update = (state, method, context) => { | ||
const cat = getRLCategory(state.settings.privMethods, method) | ||
const limitConfig = state.limitConfig | ||
const now = Date.now() | ||
const any = state.calls | ||
if (!state.catInfo.has(category)) { | ||
state.catInfo.set(category, { intvl: limitConfig.baseIntvl, last: 0 }) | ||
if (!state.catInfo.has(cat)) { | ||
state.catInfo.set(cat, { intvl: limitConfig.baseIntvl, last: 0 }) | ||
} | ||
@@ -67,3 +114,3 @@ if (context === 'pass' || context === 'fail') { | ||
const spec = state.catInfo.get(category) | ||
const spec = state.catInfo.get(cat) | ||
@@ -78,2 +125,14 @@ any.attmp = any.attmp.filter(t => t > now - limitConfig.pileUpWindow) | ||
if (spec.intvl < limitConfig.minIntvl) spec.intvl = limitConfig.minIntvl | ||
if (cat === 'auth' && context === undefined) { | ||
const now = Date.now() | ||
const elapsed = now - state.authCounter.time | ||
const intervalsPassed = | ||
elapsed / getAuthDecrementInterval(state.settings.tier) | ||
let newCount = state.authCounter.count - intervalsPassed | ||
if (newCount < 0) newCount = 0 | ||
newCount += getAuthIncrementAmt(method) | ||
state.authCounter.count = newCount | ||
state.authCounter.time = now | ||
} | ||
} | ||
@@ -117,3 +176,7 @@ | ||
}, | ||
catInfo: new Map() | ||
catInfo: new Map(), | ||
authCounter: { | ||
count: 0, | ||
time: Date.now() | ||
} | ||
} | ||
@@ -135,35 +198,48 @@ /** | ||
* @function API~RateLimits~Attempt | ||
* @param {API~RateLimits~Category} category - Type of category based on rate-limiting behavior. | ||
* @returns {Promise} Resolves when an adequate wait period has been completed. | ||
* @param {Kraken~Method} method - Method being called. | ||
* @returns {Promise} Resolves when an adequate wait period has been completed. | ||
*/ | ||
attempt: category => new Promise(resolve => { | ||
const now = Date.now() | ||
const any = state.calls | ||
update(state, category) | ||
const spec = state.catInfo.get(category) | ||
const elapsedAny = now - any.attmp.slice(-2)[0] | ||
const elapsedSpec = now - spec.last | ||
spec.last = now | ||
attempt: method => | ||
new Promise(resolve => { | ||
const now = Date.now() | ||
const any = state.calls | ||
update(state, method) | ||
const cat = getRLCategory(state.settings.privMethods, method) | ||
const spec = state.catInfo.get(cat) | ||
const elapsedAny = now - any.attmp.slice(-2)[0] | ||
const elapsedSpec = now - spec.last | ||
spec.last = now | ||
let wait | ||
let wait | ||
if (elapsedAny > any.intvl) { | ||
if (elapsedSpec > spec.intvl) { | ||
wait = 0 | ||
if (elapsedAny > any.intvl) { | ||
if (elapsedSpec > spec.intvl) { | ||
wait = 0 | ||
} else { | ||
wait = spec.intvl - elapsedSpec | ||
} | ||
} else { | ||
wait = spec.intvl - elapsedSpec | ||
} | ||
} else { | ||
if (elapsedSpec > spec.intvl) { | ||
wait = any.intvl - elapsedAny | ||
} else { | ||
if (spec.intvl - elapsedSpec > any.intvl - elapsedAny) { | ||
wait = spec.intvl - elapsedSpec | ||
if (elapsedSpec > spec.intvl) { | ||
wait = any.intvl - elapsedAny | ||
} else { | ||
wait = any.intvl - elapsedAny | ||
if (spec.intvl - elapsedSpec > any.intvl - elapsedAny) { | ||
wait = spec.intvl - elapsedSpec | ||
} else { | ||
wait = any.intvl - elapsedAny | ||
} | ||
} | ||
} | ||
} | ||
setTimeout(resolve, wait) | ||
}), | ||
if (cat === 'auth') { | ||
const countDiff = | ||
state.authCounter.count - getAuthCounterLimit(state.settings.tier) | ||
if (countDiff > 0) { | ||
const authWait = | ||
countDiff * getAuthDecrementInterval(state.settings.tier) | ||
if (authWait > wait) wait = authWait | ||
} | ||
} | ||
setTimeout(resolve, wait) | ||
}), | ||
/** | ||
@@ -173,7 +249,7 @@ * Registers any response that is not a rate-limit violation and updates frequencies accordingly. | ||
* @function API~RateLimits~AddPass | ||
* @param {API~RateLimits~Category} category - Type of category based on rate-limiting behavior. | ||
* @returns {boolean} True if successfully updated. | ||
* @param {Kraken~Method} method - Method being called. | ||
* @returns {boolean} True if successfully updated. | ||
*/ | ||
addPass: category => { | ||
update(state, category, 'pass') | ||
addPass: method => { | ||
update(state, method, 'pass') | ||
return true | ||
@@ -185,11 +261,11 @@ }, | ||
* @function API~RateLimits~AddFail | ||
* @param {API~RateLimits~Category} category - Type of category based on rate-limiting behavior. | ||
* @returns {boolean} True if successfully updated. | ||
* @param {Kraken~Method} method - Method being called. | ||
* @returns {boolean} True if successfully updated. | ||
*/ | ||
addFail: category => { | ||
update(state, category, 'fail') | ||
addFail: method => { | ||
update(state, method, 'fail') | ||
return true | ||
}, | ||
/** | ||
* Gets the type of server-side rate-limiter category based on the method. | ||
* Gets the type of server-side rate-limiter category based on the method. Wrapper for {@link API~RateLimits~GetRLCategory}. | ||
* | ||
@@ -200,11 +276,3 @@ * @function API~RateLimits~GetCategory | ||
*/ | ||
getCategory: method => ( | ||
method === 'OHLC' | ||
? 'ohlc' | ||
: method === 'Trades' | ||
? 'trades' | ||
: settings.privMethods.includes(method) | ||
? 'auth' | ||
: 'other' | ||
), | ||
getCategory: method => getRLCategory(state.settings.privMethods, method), | ||
/** | ||
@@ -219,8 +287,4 @@ * Gets the frequency required for sustainable execution of a private method. | ||
getAuthRegenIntvl: (method, tier) => { | ||
const increment = method === 'Ledgers' || method === 'TradesHistory' | ||
? 2 | ||
: method === 'AddOrder' || method === 'CancelOrder' | ||
? 0 | ||
: 1 | ||
const decIntvl = tier === 4 ? 1000 : tier === 3 ? 2000 : 3000 | ||
const increment = getAuthIncrementAmt(method) | ||
const decIntvl = getAuthDecrementInterval(method, tier) | ||
return increment * decIntvl | ||
@@ -227,0 +291,0 @@ } |
@@ -0,1 +1,16 @@ | ||
<a name="0.3.0"></a> | ||
## [0.3.0](https://github.com/jpcx/node-kraken-api/tree/0.3.0) (2018-07-20) | ||
| __[Changes since 0.2.0](https://github.com/jpcx/node-kraken-api/compare/0.2.0...0.3.0)__ | [Release Notes](https://github.com/jpcx/node-kraken-api/releases/tag/0.3.0) | [README](https://github.com/jpcx/node-kraken-api/tree/0.3.0/README.md) | | ||
| --- | --- | --- | | ||
| [Source Code (zip)](https://github.com/jpcx/node-kraken-api/archive/0.3.0.zip) | [Source Code (tar.gz)](https://github.com/jpcx/node-kraken-api/archive/0.3.0.tar.gz) | | ||
| --- | --- | | ||
#### Features | ||
+ __RateLimits:__ Implemented authenticated call rate-limiting using a counter as defined in Kraken API Docs. | ||
#### Bugfixes | ||
+ __README:__ Reduced donation qr size. | ||
<a name="0.2.0"></a> | ||
@@ -2,0 +17,0 @@ ## [0.2.0](https://github.com/jpcx/node-kraken-api/tree/0.2.0) (2018-06-26) |
@@ -10,4 +10,4 @@ Module: API/Calls/GenRequestData | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~Config) | Execution settings. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~Params) | Object containing call specs. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md#~Config) | Execution settings. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/genRequestData.js), [line 12](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/genRequestData.js#L12) | ||
* [node-kraken-api/api/calls/genRequestData.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/genRequestData.js), [line 12](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/genRequestData.js#L12) | ||
@@ -26,22 +26,22 @@ ##### Returns: | ||
[API\~Calls~RequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~RequestData) | ||
[API\~Calls~RequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~RequestData) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
@@ -10,4 +10,4 @@ Module: API/Calls/LoadCall | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~Config) | Execution settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md#~Config) | Execution settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/loadCall.js), [line 238](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/loadCall.js#L238) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js), [line 238](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js#L238) | ||
@@ -26,22 +26,22 @@ ##### Returns: | ||
[API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~Call) | ||
[API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~Call) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
@@ -10,6 +10,6 @@ Module: API/Calls/SignRequest | ||
| --- | --- | --- | | ||
| `secret` | [Kraken~Secret](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Secret) | Kraken API secret key. | | ||
| `nonce` | [Kraken~Nonce](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Nonce) | Kraken API nonce. | | ||
| `post` | [Kraken~HTTPSRequestPOSTData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~HTTPSRequestPOSTData) | POST data. | | ||
| `path` | [Kraken~Path](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Path) | Path to Kraken Method URL. | | ||
| `secret` | [Kraken~Secret](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Secret) | Kraken API secret key. | | ||
| `nonce` | [Kraken~Nonce](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Nonce) | Kraken API nonce. | | ||
| `post` | [Kraken~HTTPSRequestPOSTData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~HTTPSRequestPOSTData) | POST data. | | ||
| `path` | [Kraken~Path](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/signRequest.js), [line 11](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/signRequest.js#L11) | ||
* [node-kraken-api/api/calls/signRequest.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/signRequest.js), [line 11](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/signRequest.js#L11) | ||
@@ -28,22 +28,22 @@ ##### Returns: | ||
[API\~Calls~Signature](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~Signature) | ||
[API\~Calls~Signature](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~Signature) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
@@ -10,3 +10,3 @@ Module: API/RateLimits/LoadLimiter | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/rateLimits/loadLimiter.js), [line 77](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js#L77) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 136](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L136) | ||
@@ -25,22 +25,22 @@ ##### Returns: | ||
[API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~Functions) | ||
[API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~Functions) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
@@ -10,5 +10,5 @@ Module: API/Syncing/LoadSync | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~Config) | Settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~Call) | Stateful call function. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md#~Config) | Settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/syncing/loadSync.js), [line 280](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js#L280) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js), [line 280](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js#L280) | ||
@@ -27,22 +27,22 @@ ##### Returns: | ||
[API\~Syncing~Sync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~Sync) | ||
[API\~Syncing~Sync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~Sync) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
@@ -10,3 +10,3 @@ Module: node-kraken-api | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~Config) | User-defined settings. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/index.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.2.0/index.js#L14) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/index.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.3.0/index.js#L14) | ||
@@ -33,22 +33,22 @@ ##### Throws: | ||
[API~Functions](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md#~Functions) | ||
[API~Functions](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md#~Functions) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
@@ -10,3 +10,3 @@ Module: Settings/ParseSettings | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~Config) | Current supplied custom settings configuration. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/settings/parseSettings.js), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.2.0/settings/parseSettings.js#L13) | ||
* [node-kraken-api/settings/parseSettings.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/settings/parseSettings.js), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.3.0/settings/parseSettings.js#L13) | ||
@@ -33,22 +33,22 @@ ##### Throws: | ||
[Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~Config) | ||
[Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md#~Config) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/tools/alphabetizeNested.js), [line 4](https://github.com/jpcx/node-kraken-api/blob/0.2.0/tools/alphabetizeNested.js#L4) | ||
* [node-kraken-api/tools/alphabetizeNested.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/tools/alphabetizeNested.js), [line 4](https://github.com/jpcx/node-kraken-api/blob/0.3.0/tools/alphabetizeNested.js#L4) | ||
@@ -28,18 +28,18 @@ ##### Returns: | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
Module: Tools/ParseNested | ||
========================= | ||
Parses objects based on [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md#~ParseNestedConfig). | ||
Parses objects based on [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md#~ParseNestedConfig). | ||
@@ -10,3 +10,3 @@ ##### Parameters: | ||
| --- | --- | --- | | ||
| `config` | [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md#~ParseNestedConfig) | Parse types config. | | ||
| `config` | [Tools~ParseNestedConfig](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/tools/parseNested.js), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.2.0/tools/parseNested.js#L13) | ||
* [node-kraken-api/tools/parseNested.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/tools/parseNested.js), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.3.0/tools/parseNested.js#L13) | ||
@@ -30,18 +30,18 @@ ##### Returns: | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
@@ -7,11 +7,11 @@ # API | ||
* [node-kraken-api/api/api.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/api.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/api.jsdoc#L7) | ||
* [node-kraken-api/api/api.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/api.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/api.jsdoc#L7) | ||
### Namespaces | ||
[Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
[Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
[RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
[RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
[Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
[Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
@@ -29,3 +29,3 @@ ### Methods | ||
| --- | --- | --- | | ||
| `limiter` | [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~RateLimiter) | New limiter settings. | | ||
| `limiter` | [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md#~RateLimiter) | New limiter settings. | | ||
@@ -35,3 +35,3 @@ | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/index.js), [line 87](https://github.com/jpcx/node-kraken-api/blob/0.2.0/index.js#L87) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/index.js), [line 87](https://github.com/jpcx/node-kraken-api/blob/0.3.0/index.js#L87) | ||
@@ -63,3 +63,3 @@ ##### Throws: | ||
| --- | --- | --- | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~OTP) | New two-factor password. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~OTP) | New two-factor password. | | ||
@@ -69,3 +69,3 @@ | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/index.js), [line 28](https://github.com/jpcx/node-kraken-api/blob/0.2.0/index.js#L28) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/index.js), [line 28](https://github.com/jpcx/node-kraken-api/blob/0.3.0/index.js#L28) | ||
@@ -97,3 +97,3 @@ ##### Throws: | ||
| --- | --- | --- | | ||
| `retryCt` | [API\~Calls~RetryCount](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~RetryCount) | New retryCt. | | ||
| `retryCt` | [API\~Calls~RetryCount](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~RetryCount) | New retryCt. | | ||
@@ -103,3 +103,3 @@ | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/index.js), [line 66](https://github.com/jpcx/node-kraken-api/blob/0.2.0/index.js#L66) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/index.js), [line 66](https://github.com/jpcx/node-kraken-api/blob/0.3.0/index.js#L66) | ||
@@ -131,3 +131,3 @@ ##### Throws: | ||
| --- | --- | --- | | ||
| `timeout` | [API\~Calls~Timeout](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~Timeout) | New timeout. | | ||
| `timeout` | [API\~Calls~Timeout](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~Timeout) | New timeout. | | ||
@@ -137,3 +137,3 @@ | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/index.js), [line 45](https://github.com/jpcx/node-kraken-api/blob/0.2.0/index.js#L45) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/index.js), [line 45](https://github.com/jpcx/node-kraken-api/blob/0.3.0/index.js#L45) | ||
@@ -167,4 +167,4 @@ ##### Throws: | ||
| --- | --- | --- | | ||
| `err` | [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~CallError) | Request errors. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~CallData) | Response data. | | ||
| `err` | [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~CallError) | Request errors. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~CallData) | Response data. | | ||
@@ -174,3 +174,3 @@ | ||
* [node-kraken-api/api/api.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/api.jsdoc), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/api.jsdoc#L13) | ||
* [node-kraken-api/api/api.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/api.jsdoc), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/api.jsdoc#L13) | ||
@@ -190,8 +190,8 @@ <a name="~Functions"></a> | ||
| --- | --- | --- | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~Call) | Call a single method. | | ||
| `sync` | [API\~Syncing~Sync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~Sync) | Create a sync instance. | | ||
| `setOTP` | [API~SetOTP](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md#~SetOTP) | Sets new two-factor password. | | ||
| `setTimeout` | [API~SetTimeout](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md#~SetTimeout) | Sets a new timeout. | | ||
| `setRetryCt` | [API~SetRetryCt](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md#~SetRetryCt) | Sets a new retryCt. | | ||
| `setLimiter` | [API~SetLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md#~SetLimiter) | Sets new limiter settings. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~Call) | Call a single method. | | ||
| `sync` | [API\~Syncing~Sync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~Sync) | Create a sync instance. | | ||
| `setOTP` | [API~SetOTP](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md#~SetOTP) | Sets new two-factor password. | | ||
| `setTimeout` | [API~SetTimeout](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md#~SetTimeout) | Sets a new timeout. | | ||
| `setRetryCt` | [API~SetRetryCt](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md#~SetRetryCt) | Sets a new retryCt. | | ||
| `setLimiter` | [API~SetLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md#~SetLimiter) | Sets new limiter settings. | | ||
@@ -201,22 +201,22 @@ | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/index.js), [line 131](https://github.com/jpcx/node-kraken-api/blob/0.2.0/index.js#L131) | ||
* [node-kraken-api/index.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/index.js), [line 131](https://github.com/jpcx/node-kraken-api/blob/0.3.0/index.js#L131) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
@@ -1,2 +0,2 @@ | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md)~Calls | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.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.2.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.2.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.3.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.3.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.3.0/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.2.0/api/calls/calls.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L7) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc#L7) | ||
@@ -31,5 +31,5 @@ ### Methods | ||
| --- | --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Options) | \<optional> | Method-specific options. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Options) | \<optional> | Method-specific options. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/loadCall.js), [line 263](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/loadCall.js#L263) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js), [line 263](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js#L263) | ||
##### Throws: | ||
Throws 'Invalid method' if method is not found in [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/Settings.md#~Config). | ||
@@ -67,3 +67,3 @@ Type | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~Config) | Instance settings. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/loadCall.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/loadCall.js#L14) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js#L14) | ||
@@ -94,4 +94,4 @@ ##### Returns: | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~Config) | Instance settings. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~Params) | Call parameters. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md#~Config) | Instance settings. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/loadCall.js), [line 59](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/loadCall.js#L59) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js), [line 59](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.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.3.0/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.2.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~OTP) | Two-factor password. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md#~Callback) | Listener for errors and data. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~OTP) | Two-factor password. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/loadCall.js), [line 180](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/loadCall.js#L180) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js), [line 180](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js#L180) | ||
@@ -149,3 +149,3 @@ ##### Throws: | ||
[API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~Arguments) | ||
[API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/docs/namespaces/Settings.md#~Config) | Execution settings configuraiton. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~Category) | Rate-limit category. | | ||
| `thread` | [API\~Calls~Thread](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.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.2.0/docs/namespaces/API/RateLimits.md#~Functions) | Rate-limit handler. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md#~Config) | Execution settings configuraiton. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~Category) | Rate-limit category. | | ||
| `thread` | [API\~Calls~Thread](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.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.3.0/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.2.0/api/calls/loadCall.js), [line 89](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/loadCall.js#L89) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js), [line 89](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.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.3.0/docs/namespaces/Settings.md#~Config).retryCt. | ||
@@ -192,7 +192,7 @@ ##### Parameters: | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~Config) | Execution settings configuraiton. | | ||
| `state` | [API\~Calls~State](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~State) | Current state variables. | | ||
| `args` | [API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~Arguments) | Call-specific arguments. | | ||
| `opListener` | [API\~Calls~OpListener](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.0/docs/namespaces/API.md#~Callback). | | ||
| `retryCt` | [API\~Calls~RetryCount](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/Settings.md#~Config) | Execution settings configuraiton. | | ||
| `state` | [API\~Calls~State](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~State) | Current state variables. | | ||
| `args` | [API\~Calls~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~Arguments) | Call-specific arguments. | | ||
| `opListener` | [API\~Calls~OpListener](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.0/docs/namespaces/API.md#~Callback). | | ||
| `retryCt` | [API\~Calls~RetryCount](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/loadCall.js), [line 136](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/loadCall.js#L136) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js), [line 136](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js#L136) | ||
@@ -220,5 +220,5 @@ ### Type Definitions | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Method) | Call method. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md#~Callback) | Callback for error or data. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method) | Call method. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `cb` | [API~Callback](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/calls.jsdoc), [line 16](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L16) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 16](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/calls.jsdoc), [line 51](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L51) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 51](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/calls.jsdoc), [line 45](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L45) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 45](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.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.3.0/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.2.0/docs/namespaces/API/RateLimits.md#~Category), [API\~Calls~Thread](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~Thread)> | ||
* Map.<[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~Category), [API\~Calls~Thread](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~Thread)> | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc), [line 101](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L101) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 101](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/docs/namespaces/API/Calls.md#~RetryListener)> | ||
* Set.<[API\~Calls~RetryListener](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~RetryListener)> | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc), [line 107](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L107) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 107](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/docs/namespaces/API/Calls.md#~CallError) | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/API/Calls.md#~CallError) | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/calls.jsdoc), [line 83](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L83) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 83](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/calls.jsdoc), [line 57](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L57) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 57](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.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.2.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.3.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.3.0/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.2.0/api/calls/calls.jsdoc), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L31) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/calls.jsdoc), [line 77](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L77) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 77](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.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.2.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.3.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.3.0/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.2.0/docs/namespaces/API/Calls.md#~CallError) | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/API/Calls.md#~CallError) | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/calls.jsdoc), [line 92](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L92) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 92](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.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.3.0/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.2.0/api/calls/calls.jsdoc), [line 65](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L65) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 65](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/docs/namespaces/API/Calls.md#~SerialParams), [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~Params)> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~SerialParams), [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~Params)> | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc), [line 71](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L71) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 71](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/calls.jsdoc), [line 39](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L39) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 39](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/docs/namespaces/Settings.md#~Config) | Execution settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter object. | | ||
| `catThreads` | [API\~Calls~CatThreads](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~CatThreads) | Category-based execution threads. | | ||
| `serialReg` | [API\~Calls~SerialRegistry](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/Settings.md#~Config) | Execution settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter object. | | ||
| `catThreads` | [API\~Calls~CatThreads](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~CatThreads) | Category-based execution threads. | | ||
| `serialReg` | [API\~Calls~SerialRegistry](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/loadCall.js), [line 247](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/loadCall.js#L247) | ||
* [node-kraken-api/api/calls/loadCall.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js), [line 247](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/loadCall.js#L247) | ||
@@ -457,7 +457,7 @@ <a name="~Thread"></a> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~SerialParams), [API\~Calls~ListenerSet](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~ListenerSet)> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~SerialParams), [API\~Calls~ListenerSet](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~ListenerSet)> | ||
Source: | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc), [line 113](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L113) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 113](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/calls/calls.jsdoc), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/calls/calls.jsdoc#L25) | ||
* [node-kraken-api/api/calls/calls.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/calls/calls.jsdoc#L25) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
@@ -1,2 +0,2 @@ | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md)~RateLimits | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.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.2.0/docs/namespaces/Kraken.md#~Tier), [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Method), and [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~RateLimiter). | | ||
| `LoadLimiter` | [module:API/RateLimits/LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.0/docs/namespaces/Kraken.md#~Tier), [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method), and [Settings~RateLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/rateLimits/rateLimits.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/rateLimits.jsdoc#L7) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/rateLimits.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/rateLimits.jsdoc#L7) | ||
@@ -21,3 +21,3 @@ ### Methods | ||
<a name="~AddFail"></a> | ||
#### (inner) AddFail(category) → \{boolean} | ||
#### (inner) AddFail(method) → \{boolean} | ||
@@ -30,3 +30,3 @@ Registers a new rate-limit violation and updates frequencies accordingly. | ||
| --- | --- | --- | | ||
| `category` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~Category) | Type of category based on rate-limiting behavior. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
@@ -36,3 +36,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js), [line 174](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js#L174) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 250](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L250) | ||
@@ -48,3 +48,3 @@ ##### Returns: | ||
<a name="~AddPass"></a> | ||
#### (inner) AddPass(category) → \{boolean} | ||
#### (inner) AddPass(method) → \{boolean} | ||
@@ -57,3 +57,3 @@ Registers any response that is not a rate-limit violation and updates frequencies accordingly. | ||
| --- | --- | --- | | ||
| `category` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~Category) | Type of category based on rate-limiting behavior. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
@@ -63,3 +63,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js), [line 163](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js#L163) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 239](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L239) | ||
@@ -75,3 +75,3 @@ ##### Returns: | ||
<a name="~Attempt"></a> | ||
#### (inner) Attempt(category) → \{Promise} | ||
#### (inner) Attempt(method) → \{Promise} | ||
@@ -84,3 +84,3 @@ Registers a new call attempt and returns a promise that signifies that the call placement may be submitted. | ||
| --- | --- | --- | | ||
| `category` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~Category) | Type of category based on rate-limiting behavior. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
@@ -90,3 +90,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js), [line 126](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js#L126) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 189](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L189) | ||
@@ -104,3 +104,3 @@ ##### Returns: | ||
Checks the response context for [API\~RateLimits~Update](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/API/RateLimits.md#~Update) and adjusts call frequency accordingly. | ||
@@ -112,5 +112,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` | [API\~RateLimits~LimitConfig](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~LimitConfig) | Rate-limiter settings configuration. | | ||
| `any` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.0/docs/namespaces/API/RateLimits.md#~CatInfo) | Rate information for specific [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~Category). | | ||
| `limitConfig` | [API\~RateLimits~LimitConfig](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~LimitConfig) | Rate-limiter settings configuration. | | ||
| `any` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.0/docs/namespaces/API/RateLimits.md#~CatInfo) | Rate information for specific [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~Category). | | ||
@@ -120,3 +120,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js#L25) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 71](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L71) | ||
@@ -132,4 +132,4 @@ <a name="~CheckPileUp"></a> | ||
| --- | --- | --- | | ||
| `limitConfig` | [API\~RateLimits~LimitConfig](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~LimitConfig) | Rate-limiter settings configuration. | | ||
| `any` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~CallInfo) | Rate information for all calls. | | ||
| `limitConfig` | [API\~RateLimits~LimitConfig](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~LimitConfig) | Rate-limiter settings configuration. | | ||
| `any` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~CallInfo) | Rate information for all calls. | | ||
@@ -139,4 +139,76 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js), [line 9](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js#L9) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 55](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L55) | ||
<a name="~GetAuthCounterLimit"></a> | ||
#### (inner) GetAuthCounterLimit(tier) → \{[Kraken~AuthCounterLimit](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~AuthCounterLimit)} | ||
Returns the maximum counter value for authenticated methods. | ||
##### Parameters: | ||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Tier) | Kraken verification tier. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L31) | ||
##### Returns: | ||
Maximum count for auth counter. | ||
Type | ||
[Kraken~AuthCounterLimit](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~AuthCounterLimit) | ||
<a name="~GetAuthDecrementInterval"></a> | ||
#### (inner) GetAuthDecrementInterval(tier) → \{[Kraken~AuthDecrementInterval](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~AuthDecrementInterval)} | ||
Returns the amount of time required to decrement the auth counter. | ||
##### Parameters: | ||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Tier) | Kraken verification tier. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 21](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L21) | ||
##### Returns: | ||
Amount of time required to decrement the counter. | ||
Type | ||
[Kraken~AuthDecrementInterval](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~AuthDecrementInterval) | ||
<a name="~GetAuthIncrementAmt"></a> | ||
#### (inner) GetAuthIncrementAmt(method) → \{[Kraken~AuthIncrementAmount](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~AuthIncrementAmount)} | ||
Returns the amount of counter incrementation based on the method. | ||
##### Parameters: | ||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 9](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L9) | ||
##### Returns: | ||
Amount to increment the auth counter. | ||
Type | ||
[Kraken~AuthIncrementAmount](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~AuthIncrementAmount) | ||
<a name="~GetAuthRegenIntvl"></a> | ||
@@ -151,4 +223,4 @@ #### (inner) GetAuthRegenIntvl(method, tier) → \{number} | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Tier) | Current verification tier. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Tier) | Current verification tier. | | ||
@@ -158,3 +230,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js), [line 201](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js#L201) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 269](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L269) | ||
@@ -170,5 +242,5 @@ ##### Returns: | ||
<a name="~GetCategory"></a> | ||
#### (inner) GetCategory(method) → \{[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~Category)} | ||
#### (inner) GetCategory(method) → \{[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~Category)} | ||
Gets the type of server-side rate-limiter category based on the method. | ||
Gets the type of server-side rate-limiter category based on the method. Wrapper for [API\~RateLimits~GetRLCategory](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~GetRLCategory). | ||
@@ -179,3 +251,3 @@ ##### Parameters: | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
@@ -185,3 +257,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js), [line 185](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js#L185) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 261](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L261) | ||
@@ -194,8 +266,33 @@ ##### Returns: | ||
[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~Category) | ||
[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~Category) | ||
<a name="~GetRLCategory"></a> | ||
#### (inner) GetRLCategory(privMethods, method) → \{[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~Category)} | ||
Returns the rate-limit category for a given method. Different categories follow different server-side limiting behavior. | ||
##### Parameters: | ||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| `privMethods` | [Kraken~PrivateMethods](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~PrivateMethods) | List of all available private methods. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
Source: | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 40](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L40) | ||
##### Returns: | ||
Rate-limiting category. | ||
Type | ||
[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~Category) | ||
<a name="~Update"></a> | ||
#### (inner) Update(state, category, contextopt) | ||
#### (inner) Update(state, method, contextopt) | ||
Updates [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~CallInfo) and [API\~RateLimits~CatInfo](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/API/RateLimits.md#~CallInfo) and [API\~RateLimits~CatInfo](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~CatInfo) intervals in response to server response behavior. | ||
@@ -206,4 +303,4 @@ ##### Parameters: | ||
| --- | --- | --- | --- | | ||
| `state` | [API\~RateLimits~State](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.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.3.0/docs/namespaces/API/RateLimits.md#~State) | | Stateful registry of limiter information. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `context` | 'pass' \| 'fail' | \<optional> | Reason for invocation; may be called in response to a successful call, a rate limit violation, or a pre-response call attempt. | | ||
@@ -214,3 +311,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js), [line 46](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js#L46) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 92](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L92) | ||
@@ -239,3 +336,3 @@ ### Type Definitions | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/rateLimits.jsdoc), [line 20](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/rateLimits.jsdoc#L20) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/rateLimits.jsdoc), [line 20](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/rateLimits.jsdoc#L20) | ||
@@ -253,3 +350,3 @@ <a name="~Category"></a> | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/rateLimits.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/rateLimits.jsdoc#L14) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/rateLimits.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/rateLimits.jsdoc#L14) | ||
@@ -275,3 +372,3 @@ <a name="~CatInfo"></a> | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/rateLimits.jsdoc), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/rateLimits.jsdoc#L35) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/rateLimits.jsdoc), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/rateLimits.jsdoc#L35) | ||
@@ -291,7 +388,7 @@ <a name="~Functions"></a> | ||
| --- | --- | --- | | ||
| `attempt` | [API\~RateLimits~Attempt](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.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.2.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.2.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.2.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.3.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.3.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.3.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.3.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.3.0/docs/namespaces/API/RateLimits.md#~GetAuthRegenIntvl) | Gets the amount of time necessary for a given private method to be called sustainably. | | ||
@@ -301,3 +398,3 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js), [line 115](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js#L115) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 178](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L178) | ||
@@ -331,3 +428,3 @@ <a name="~LimitConfig"></a> | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/rateLimits.jsdoc), [line 43](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/rateLimits.jsdoc#L43) | ||
* [node-kraken-api/api/rateLimits/rateLimits.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/rateLimits.jsdoc), [line 43](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/rateLimits.jsdoc#L43) | ||
@@ -343,6 +440,6 @@ <a name="~State"></a> | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `limitConfig` | [API\~RateLimits~LimitConfig](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~LimitConfig) | Rate limter behavior configuration. | | ||
| `calls` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.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.3.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `limitConfig` | [API\~RateLimits~LimitConfig](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~LimitConfig) | Rate limter behavior configuration. | | ||
| `calls` | [API\~RateLimits~CallInfo](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.0/docs/namespaces/API/RateLimits.md#~CatInfo) | Map of category to object containing category-specific rate information. | | ||
@@ -352,22 +449,22 @@ | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js), [line 85](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/rateLimits/loadLimiter.js#L85) | ||
* [node-kraken-api/api/rateLimits/loadLimiter.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js), [line 144](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/rateLimits/loadLimiter.js#L144) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
@@ -1,4 +0,4 @@ | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md)~Syncing | ||
# [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md)~Syncing | ||
Types and methods specific to scheduling persistent [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/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.2.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.3.0/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.2.0/api/syncing/syncing.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc#L7) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.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.3.0/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.2.0/docs/namespaces/API/Syncing.md#~EventListener) | Listener function to add. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/api/syncing/loadSync.js), [line 443](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js#L443) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js), [line 443](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js#L443) | ||
@@ -54,3 +54,3 @@ ##### Returns: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js), [line 416](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js#L416) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js), [line 416](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js#L416) | ||
@@ -68,3 +68,3 @@ ##### Returns: | ||
Handles request queue and sends data to associated [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/API/Syncing.md#~EventListener)s. | ||
@@ -75,4 +75,4 @@ ##### Parameters: | ||
| --- | --- | --- | | ||
| `state` | [API\~Syncing~State](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~Category) | Current rate-limit category. | | ||
| `state` | [API\~Syncing~State](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~Category) | Current rate-limit category. | | ||
@@ -82,3 +82,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js), [line 132](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js#L132) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js), [line 132](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js#L132) | ||
@@ -96,3 +96,3 @@ ##### Returns: | ||
Adds a one-time [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.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. | ||
@@ -103,3 +103,3 @@ ##### Parameters: | ||
| --- | --- | --- | --- | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/API/Syncing.md#~EventListener) | \<optional> | Once listener function to add. | | ||
@@ -109,3 +109,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js), [line 459](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js#L459) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js), [line 459](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js#L459) | ||
@@ -127,3 +127,3 @@ ##### Returns: | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js), [line 372](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js#L372) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js), [line 372](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js#L372) | ||
@@ -139,3 +139,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.2.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.3.0/docs/namespaces/API/Syncing.md#~Arguments)} | ||
@@ -148,7 +148,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.2.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~EventListener) | Listener for errors and data. | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md#~Config) | Current settings configuration. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~EventListener) | Listener for errors and data. | | ||
@@ -158,3 +158,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js), [line 209](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js#L209) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js), [line 209](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js#L209) | ||
@@ -175,3 +175,3 @@ ##### Throws: | ||
[API\~Syncing~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~Arguments) | ||
[API\~Syncing~Arguments](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~Arguments) | ||
@@ -181,3 +181,3 @@ <a name="~RemoveListener"></a> | ||
Disassociates an [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~EventListener) from the instance. | ||
Disassociates an [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~EventListener) from the instance. | ||
@@ -188,3 +188,3 @@ ##### Parameters: | ||
| --- | --- | --- | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~EventListener) | Listener function to remove. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~EventListener) | Listener function to remove. | | ||
@@ -194,3 +194,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js), [line 451](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js#L451) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js), [line 451](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js#L451) | ||
@@ -206,3 +206,3 @@ ##### Returns: | ||
<a name="~Sync"></a> | ||
#### (inner) Sync(method, optionsopt, intervalopt, listeneropt) → \{[API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/API/Syncing.md#~Instance)} | ||
@@ -215,6 +215,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.2.0/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Options) | \<optional> | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.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.3.0/docs/namespaces/Kraken.md#~Method) | | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Options) | \<optional> | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.0/docs/namespaces/API/Syncing.md#~EventListener) | \<optional> | Listener for error and data events. | | ||
@@ -224,3 +224,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js), [line 307](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js#L307) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js), [line 307](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js#L307) | ||
@@ -241,3 +241,3 @@ ##### Throws: | ||
[API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~Instance) | ||
[API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~Instance) | ||
@@ -253,6 +253,6 @@ <a name="~VerifyInternals"></a> | ||
| --- | --- | --- | | ||
| `state` | [API\~Syncing~State](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.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.2.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.3.0/docs/namespaces/API/Syncing.md#~State) | Object containing runtime data. | | ||
| `cat` | [API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.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.3.0/docs/namespaces/API/Syncing.md#~InternalSet) | Set of all internals associated with the current thread. | | ||
@@ -262,3 +262,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js), [line 11](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js#L11) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js), [line 11](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js#L11) | ||
@@ -280,5 +280,5 @@ ### Type Definitions | ||
| --- | --- | --- | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `listener` | [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~EventListener) | Event listener for sync error and data events. | | ||
@@ -288,3 +288,3 @@ | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc#L14) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc#L14) | ||
@@ -294,11 +294,11 @@ <a name="~CatThreads"></a> | ||
Holds maps of [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/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.2.0/docs/namespaces/API/RateLimits.md#~Category), [API\~Syncing~Thread](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~Thread)> | ||
* Map.<[API\~RateLimits~Category](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~Category), [API\~Syncing~Thread](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~Thread)> | ||
Source: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc), [line 57](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc#L57) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc), [line 57](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc#L57) | ||
@@ -308,3 +308,3 @@ <a name="~Error"></a> | ||
Timestamped [API\~Calls~CallError](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.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. | ||
@@ -324,3 +324,3 @@ ##### Type: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc), [line 50](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc#L50) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc), [line 50](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc#L50) | ||
@@ -336,5 +336,5 @@ <a name="~EventListener"></a> | ||
| --- | --- | --- | --- | | ||
| `err` | [API\~Syncing~Error](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~Error) | | Sync error. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~CallData) | | Data received from call. | | ||
| `instance` | [API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/API/Syncing.md#~Error) | | Sync error. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~CallData) | | Data received from call. | | ||
| `instance` | [API\~Syncing~Instance](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~Instance) | \<optional> | Reference to the current instance, if necessary. | | ||
@@ -344,3 +344,3 @@ | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc), [line 41](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc#L41) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc), [line 41](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc#L41) | ||
@@ -360,13 +360,13 @@ <a name="~Instance"></a> | ||
| --- | --- | --- | | ||
| `status` | [API\~Syncing~Status](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update time. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.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.2.0/docs/namespaces/API/Syncing.md#~InstanceData) | Object containing data from the last successful response. | | ||
| `time` | number | Time (in ms) of last successful [API\~Syncing~InstanceData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~InstanceData) update. | | ||
| `open` | [API\~Syncing~Open](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.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.2.0/docs/namespaces/API/Syncing.md#~AddListener) | Associates a new [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~EventListener). | | ||
| `removeListener` | [API\~Syncing~RemoveListener](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~RemoveListener) | Disassociates a [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~EventListener). | | ||
| `once` | [API\~Syncing~Once](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~Once) | Adds a one-time [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~EventListener) if provided; otherwise returns a promise which resolves/rejects on the next error/data event. | | ||
| `status` | [API\~Syncing~Status](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update time. | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.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.3.0/docs/namespaces/API/Syncing.md#~InstanceData) | Object containing data from the last successful response. | | ||
| `time` | number | Time (in ms) of last successful [API\~Syncing~InstanceData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~InstanceData) update. | | ||
| `open` | [API\~Syncing~Open](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.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.3.0/docs/namespaces/API/Syncing.md#~AddListener) | Associates a new [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~EventListener). | | ||
| `removeListener` | [API\~Syncing~RemoveListener](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~RemoveListener) | Disassociates a [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~EventListener). | | ||
| `once` | [API\~Syncing~Once](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~Once) | Adds a one-time [API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~EventListener) if provided; otherwise returns a promise which resolves/rejects on the next error/data event. | | ||
@@ -376,3 +376,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js), [line 328](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js#L328) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js), [line 328](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js#L328) | ||
@@ -382,3 +382,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.2.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.2.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.3.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.3.0/docs/namespaces/API/Syncing.md#~EventListener) or otherwise. | ||
@@ -391,3 +391,3 @@ ##### Type: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc), [line 23](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc#L23) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc), [line 23](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc#L23) | ||
@@ -407,8 +407,8 @@ <a name="~Internal"></a> | ||
| --- | --- | --- | | ||
| `status` | [API\~Syncing~Status](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/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.2.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.0/docs/namespaces/API/Syncing.md#~Instance) | Instance being tracked. | | ||
| `listeners` | Set.<[API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~EventListener)> | Set of all associated event listeners. | | ||
| `interval` | [API\~Syncing~Interval](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~Interval) | Minimum sync update interval. | | ||
| `params` | [API\~Calls~Params](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.0/docs/namespaces/API/Syncing.md#~Instance) | Instance being tracked. | | ||
| `listeners` | Set.<[API\~Syncing~EventListener](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~EventListener)> | Set of all associated event listeners. | | ||
@@ -418,3 +418,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js), [line 348](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js#L348) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js), [line 348](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js#L348) | ||
@@ -428,7 +428,7 @@ <a name="~InternalSet"></a> | ||
* Set.<[API\~Syncing~Internal](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~Internal)> | ||
* Set.<[API\~Syncing~Internal](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~Internal)> | ||
Source: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc), [line 69](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc#L69) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc), [line 69](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc#L69) | ||
@@ -446,3 +446,3 @@ <a name="~Interval"></a> | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc#L35) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc), [line 35](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc#L35) | ||
@@ -462,7 +462,7 @@ <a name="~State"></a> | ||
| --- | --- | --- | | ||
| `settings` | [Settings~Config](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~Config) | Settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~Call) | Stateful call function. | | ||
| `catThreads` | [API\~Syncing~CatThreads](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.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.3.0/docs/namespaces/Settings.md#~Config) | Settings configuration. | | ||
| `limiter` | [API\~RateLimits~Functions](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md#~Functions) | Limiter instance. | | ||
| `call` | [API\~Calls~Call](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~Call) | Stateful call function. | | ||
| `catThreads` | [API\~Syncing~CatThreads](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.0/docs/namespaces/API/Calls.md#~SerialRegistry) | Maps serialized params to actual params. | | ||
@@ -472,3 +472,3 @@ | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js), [line 290](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/loadSync.js#L290) | ||
* [node-kraken-api/api/syncing/loadSync.js](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js), [line 290](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/loadSync.js#L290) | ||
@@ -478,3 +478,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.2.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.3.0/docs/namespaces/API/Calls.md#~CallData) has not been received; 'open' if queued; 'closed' if not queued. | ||
@@ -487,3 +487,3 @@ ##### Type: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc), [line 29](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc#L29) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc), [line 29](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc#L29) | ||
@@ -497,26 +497,26 @@ <a name="~Thread"></a> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~SerialParams), [API\~Syncing~InternalSet](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md#~InternalSet)> | ||
* Map.<[API\~Calls~SerialParams](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~SerialParams), [API\~Syncing~InternalSet](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md#~InternalSet)> | ||
Source: | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc), [line 63](https://github.com/jpcx/node-kraken-api/blob/0.2.0/api/syncing/syncing.jsdoc#L63) | ||
* [node-kraken-api/api/syncing/syncing.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc), [line 63](https://github.com/jpcx/node-kraken-api/blob/0.3.0/api/syncing/syncing.jsdoc#L63) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
@@ -7,13 +7,26 @@ # Kraken | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L7) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L7) | ||
### Type Definitions | ||
<a name="~CounterInterval"></a> | ||
#### CounterInterval | ||
<a name="~AuthCounterLimit"></a> | ||
#### AuthCounterLimit | ||
Number of seconds for the [Kraken~RateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~RateLimitCount) to decrement by one. Depends on the [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/Kraken.md#~Tier). See the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) for more information. | ||
##### Type: | ||
* [Kraken~AuthRateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~AuthRateLimitCount) | ||
Source: | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 122](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L122) | ||
<a name="~AuthDecrementInterval"></a> | ||
#### AuthDecrementInterval | ||
Number of seconds for the [Kraken~AuthRateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~AuthRateLimitCount) to decrement by one. Depends on the [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Tier). See the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) for more information. | ||
##### Type: | ||
* number | ||
@@ -23,17 +36,30 @@ | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 134](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L134) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 134](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L134) | ||
<a name="~CounterLimit"></a> | ||
#### CounterLimit | ||
<a name="~AuthIncrementAmount"></a> | ||
#### AuthIncrementAmount | ||
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.2.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 increment amount used for determining private API rate limit adherence. Depends on the [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/docs/namespaces/Kraken.md#~RateLimitCount) | ||
* [Kraken~AuthRateLimitCount](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~AuthRateLimitCount) | ||
Source: | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 122](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L122) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 128](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L128) | ||
<a name="~AuthRateLimitCount"></a> | ||
#### AuthRateLimitCount | ||
Counts within the the authenticated rate-limit counter. Kraken limits authenticated requests using a counter system. Counts go up when a call is made, and decay after a certain amount of time. Counter behavior is dependent on verification tier. See the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) for more information. | ||
##### Type: | ||
* number | ||
Source: | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 116](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L116) | ||
<a name="~Hostname"></a> | ||
@@ -50,3 +76,3 @@ #### Hostname | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 80](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L80) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 80](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L80) | ||
@@ -66,4 +92,4 @@ <a name="~HTTPSRequestHeaders"></a> | ||
| --- | --- | --- | | ||
| `API-Key` | [Kraken~Key](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Key) | Kraken API key. | | ||
| `API-Sign` | [API\~Calls~Signature](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/Kraken.md#~Key) | Kraken API key. | | ||
| `API-Sign` | [API\~Calls~Signature](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~Signature) | Cryptographic signature using API secret and other call parameters. | | ||
@@ -73,3 +99,3 @@ | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 92](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L92) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 92](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L92) | ||
@@ -89,6 +115,6 @@ <a name="~HTTPSRequestOptions"></a> | ||
| --- | --- | --- | | ||
| `hostname` | [Kraken~Hostname](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Hostname) | Kraken hostname. | | ||
| `path` | [Kraken~Path](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.0/docs/namespaces/Kraken.md#~Method) for the request. | | ||
| `headers` | [Kraken~HTTPSRequestHeaders](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~HTTPSRequestHeaders) | Kraken HTTPS request headers. | | ||
| `hostname` | [Kraken~Hostname](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Hostname) | Kraken hostname. | | ||
| `path` | [Kraken~Path](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.0/docs/namespaces/Kraken.md#~Method) for the request. | | ||
| `headers` | [Kraken~HTTPSRequestHeaders](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~HTTPSRequestHeaders) | Kraken HTTPS request headers. | | ||
@@ -98,3 +124,3 @@ | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 100](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L100) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 100](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L100) | ||
@@ -112,17 +138,4 @@ <a name="~HTTPSRequestPOSTData"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 110](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L110) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 110](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L110) | ||
<a name="~IncrementAmount"></a> | ||
#### IncrementAmount | ||
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.2.0/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.2.0/docs/namespaces/Kraken.md#~RateLimitCount) | ||
Source: | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 128](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L128) | ||
<a name="~Key"></a> | ||
@@ -139,3 +152,3 @@ #### Key | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L13) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 13](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L13) | ||
@@ -153,3 +166,3 @@ <a name="~Method"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 55](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L55) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 55](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L55) | ||
@@ -167,3 +180,3 @@ <a name="~Nonce"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 74](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L74) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 74](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L74) | ||
@@ -181,3 +194,3 @@ <a name="~Option"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 61](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L61) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 61](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L61) | ||
@@ -197,3 +210,3 @@ <a name="~Options"></a> | ||
| --- | --- | --- | | ||
| `*` | [Kraken~Option](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Option) | An option to send to the servers. | | ||
| `*` | [Kraken~Option](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Option) | An option to send to the servers. | | ||
@@ -203,3 +216,3 @@ | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 67](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L67) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 67](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L67) | ||
@@ -217,3 +230,3 @@ <a name="~OTP"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L31) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 31](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L31) | ||
@@ -231,3 +244,3 @@ <a name="~Path"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 86](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L86) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 86](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L86) | ||
@@ -245,3 +258,3 @@ <a name="~PrivateMethods"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 49](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L49) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 49](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L49) | ||
@@ -259,17 +272,4 @@ <a name="~PublicMethods"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 43](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L43) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 43](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L43) | ||
<a name="~RateLimitCount"></a> | ||
#### RateLimitCount | ||
Counts within the the authenticated rate-limit counter. Kraken limits authenticated requests using a counter system. Counts go up when a call is made, and decay after a certain amount of time. Counter behavior is dependent on verification tier. See the [Kraken API docs](https://www.kraken.com/help/api#api-call-rate-limit) for more information. | ||
##### Type: | ||
* number | ||
Source: | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 116](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L116) | ||
<a name="~Secret"></a> | ||
@@ -286,3 +286,3 @@ #### Secret | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 19](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L19) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 19](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L19) | ||
@@ -300,3 +300,3 @@ <a name="~Tier"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L25) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 25](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L25) | ||
@@ -314,22 +314,22 @@ <a name="~Version"></a> | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc), [line 37](https://github.com/jpcx/node-kraken-api/blob/0.2.0/kraken/kraken.jsdoc#L37) | ||
* [node-kraken-api/kraken/kraken.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc), [line 37](https://github.com/jpcx/node-kraken-api/blob/0.3.0/kraken/kraken.jsdoc#L37) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
@@ -9,3 +9,3 @@ # Settings | ||
| --- | --- | --- | | ||
| `ParseSettings` | [module:Settings/ParseSettings](module-Settings_Parsehttps://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/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.2.0/settings/settings.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.2.0/settings/settings.jsdoc#L7) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/settings/settings.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.3.0/settings/settings.jsdoc#L7) | ||
@@ -33,16 +33,16 @@ ### Type Definitions | ||
| --- | --- | --- | --- | --- | | ||
| `key` | [Kraken~Key](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Key) | \<optional> | '' | API key. | | ||
| `secret` | [Kraken~Secret](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Secret) | \<optional> | '' | API secret. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Tier) | \<optional> | 0 | Verification tier. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~OTP) | \<optional> | null | Two factor password. | | ||
| `timeout` | [API\~Calls~Timeout](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.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.2.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.2.0/docs/namespaces/Kraken.md#~Version) | \<optional> | 0 | Kraken API version. | | ||
| `pubMethods` | [Kraken~PublicMethods](https://github.com/jpcx/node-kraken-api/blob/0.2.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.2.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.2.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.2.0/docs/namespaces/Settings.md#~RateLimiter) | \<optional> | { baseIntvl: 500, minIntvl: 250 } | Settings for call interval limitations. | | ||
| `syncIntervals` | [Settings~SyncIntervals](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~SyncIntervals) | \<optional> | { Time: 2000, Assets: 2000, AssetPairs: 2000, Ticker: 2000, OHLC: 60000, Depth: 2000, Trades: 2000, Spread: 2000 } | | | ||
| `dataFormatter` | [Settings~DataFormatter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~DataFormatter) | \<optional> | null | Function for response data formatting (post-parsing, if enabled). | | ||
| `key` | [Kraken~Key](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Key) | \<optional> | '' | API key. | | ||
| `secret` | [Kraken~Secret](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Secret) | \<optional> | '' | API secret. | | ||
| `tier` | [Kraken~Tier](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Tier) | \<optional> | 0 | Verification tier. | | ||
| `otp` | [Kraken~OTP](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~OTP) | \<optional> | null | Two factor password. | | ||
| `timeout` | [API\~Calls~Timeout](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.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.3.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.3.0/docs/namespaces/Kraken.md#~Version) | \<optional> | 0 | Kraken API version. | | ||
| `pubMethods` | [Kraken~PublicMethods](https://github.com/jpcx/node-kraken-api/blob/0.3.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.3.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.3.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.3.0/docs/namespaces/Settings.md#~RateLimiter) | \<optional> | { baseIntvl: 500, minIntvl: 250 } | Settings for call interval limitations. | | ||
| `syncIntervals` | [Settings~SyncIntervals](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md#~SyncIntervals) | \<optional> | { Time: 2000, Assets: 2000, AssetPairs: 2000, Ticker: 2000, OHLC: 60000, Depth: 2000, Trades: 2000, Spread: 2000 } | | | ||
| `dataFormatter` | [Settings~DataFormatter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md#~DataFormatter) | \<optional> | null | Function for response data formatting (post-parsing, if enabled). | | ||
@@ -52,3 +52,3 @@ | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/settings/settings.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.2.0/settings/settings.jsdoc#L14) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/settings/settings.jsdoc), [line 14](https://github.com/jpcx/node-kraken-api/blob/0.3.0/settings/settings.jsdoc#L14) | ||
@@ -64,5 +64,5 @@ <a name="~DataFormatter"></a> | ||
| --- | --- | --- | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md#~CallData) | Data received from call (post-parsing, if enabled). | | ||
| `method` | [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Method) | Method being called. | | ||
| `options` | [Kraken~Options](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md#~Options) | Method-specific options. | | ||
| `data` | [API\~Calls~CallData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md#~CallData) | Data received from call (post-parsing, if enabled). | | ||
@@ -72,3 +72,3 @@ | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/settings/settings.jsdoc), [line 49](https://github.com/jpcx/node-kraken-api/blob/0.2.0/settings/settings.jsdoc#L49) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/settings/settings.jsdoc), [line 49](https://github.com/jpcx/node-kraken-api/blob/0.3.0/settings/settings.jsdoc#L49) | ||
@@ -102,3 +102,3 @@ ##### Returns: | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/settings/settings.jsdoc), [line 34](https://github.com/jpcx/node-kraken-api/blob/0.2.0/settings/settings.jsdoc#L34) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/settings/settings.jsdoc), [line 34](https://github.com/jpcx/node-kraken-api/blob/0.3.0/settings/settings.jsdoc#L34) | ||
@@ -118,3 +118,3 @@ <a name="~SyncIntervals"></a> | ||
| --- | --- | --- | | ||
| `*` | number | Name of [Kraken~Method](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/Kraken.md#~Method) and default interval (in ms). | | ||
@@ -124,22 +124,22 @@ | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.2.0/settings/settings.jsdoc), [line 42](https://github.com/jpcx/node-kraken-api/blob/0.2.0/settings/settings.jsdoc#L42) | ||
* [node-kraken-api/settings/settings.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/settings/settings.jsdoc), [line 42](https://github.com/jpcx/node-kraken-api/blob/0.3.0/settings/settings.jsdoc#L42) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
@@ -9,4 +9,4 @@ # Tools | ||
| --- | --- | --- | | ||
| `AlphabetizeNested` | [module:Tools/AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | Alphabetizes a nested Object. | | ||
| `ParseNested` | [module:Tools/ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/modules/Tools/AlphabetizeNested.md) | Alphabetizes a nested Object. | | ||
| `ParseNested` | [module:Tools/ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/tools/tools.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.2.0/tools/tools.jsdoc#L7) | ||
* [node-kraken-api/tools/tools.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/tools/tools.jsdoc), [line 7](https://github.com/jpcx/node-kraken-api/blob/0.3.0/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.2.0/tools/tools.jsdoc), [line 15](https://github.com/jpcx/node-kraken-api/blob/0.2.0/tools/tools.jsdoc#L15) | ||
* [node-kraken-api/tools/tools.jsdoc](https://github.com/jpcx/node-kraken-api/blob/0.3.0/tools/tools.jsdoc), [line 15](https://github.com/jpcx/node-kraken-api/blob/0.3.0/tools/tools.jsdoc#L15) | ||
<hr> | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.2.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
## [Home](https://github.com/jpcx/node-kraken-api/blob/0.3.0/README.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) |
{ | ||
"name": "node-kraken-api", | ||
"version": "0.2.0", | ||
"version": "0.3.0", | ||
"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": { |
@@ -160,3 +160,3 @@ # node-kraken-api | ||
#### Custom formatting of response data: | ||
Response data may be formatted in any way based on method and options by setting a [DataFormatter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~DataFormatter) function during instantiation. | ||
Response data may be formatted in any way based on method and options by setting a [DataFormatter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md#~DataFormatter) function during instantiation. | ||
@@ -410,3 +410,3 @@ ___NOTE:___ Any data returned from this function will be treated as the new data, and call responses will be undefined if it does not return anything. | ||
Configuration specifications are detailed in the documentation [here](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md#~Config) | ||
Configuration specifications are detailed in the documentation [here](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md#~Config) | ||
@@ -435,3 +435,3 @@ Additionally, various settings may be modified during runtime by using the following functions: | ||
Alternatively, refer to the [default settings](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/docs/namespaces/Settings.md#~Config) in the node-kraken-api documentation. Default method types are listed here (under the 'pubMethods' and 'privMethods' properties). | ||
@@ -450,18 +450,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.2.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.2.0/docs/namespaces/Kraken.md) | ||
+ [node-kraken-api](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/node-kraken-api.md) | ||
+ [API](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API.md) | ||
+ [Calls](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Calls.md) | ||
+ [GenRequestData](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/GenRequestData.md) | ||
+ [LoadCall](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/LoadCall.md) | ||
+ [SignRequest](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Calls/SignRequest.md) | ||
+ [RateLimits](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/RateLimits.md) | ||
+ [LoadLimiter](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/RateLimits/LoadLimiter.md) | ||
+ [Syncing](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/API/Syncing.md) | ||
+ [LoadSync](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/API/Syncing/LoadSync.md) | ||
+ [Settings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Settings.md) | ||
+ [ParseSettings](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Settings/ParseSettings.md) | ||
+ [Tools](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Tools.md) | ||
+ [AlphabetizeNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/AlphabetizeNested.md) | ||
+ [ParseNested](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/modules/Tools/ParseNested.md) | ||
+ [Kraken](https://github.com/jpcx/node-kraken-api/blob/0.3.0/docs/namespaces/Kraken.md) | ||
@@ -471,3 +471,3 @@ | ||
Versioned using [SemVer](http://semver.org/). For available versions, see the [Changelog](https://github.com/jpcx/node-kraken-api/blob/0.2.0/CHANGELOG.md). | ||
Versioned using [SemVer](http://semver.org/). For available versions, see the [Changelog](https://github.com/jpcx/node-kraken-api/blob/0.3.0/CHANGELOG.md). | ||
@@ -488,6 +488,6 @@ ## Contribution | ||
![donate](http://i65.tinypic.com/2414is4.jpg) | ||
![donate](http://i66.tinypic.com/2rp4kd5.jpg) | ||
## License | ||
This project is licensed under the MIT License - see the [LICENSE](https://github.com/jpcx/node-kraken-api/blob/0.2.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.3.0/LICENSE) file for details |
@@ -7,3 +7,3 @@ { | ||
"repo": "https://github.com/jpcx/node-kraken-api", | ||
"tag": "0.2.0", | ||
"tag": "0.3.0", | ||
"node": "8.7.0", | ||
@@ -10,0 +10,0 @@ "jsdoc": [ |
@@ -59,9 +59,9 @@ /** | ||
let starttm = Date.now() | ||
await limiter.attempt('other') | ||
await limiter.attempt('Time') | ||
expect(Date.now() - starttm).toBeGreaterThan(defaults.limiter.baseIntvl - 100) | ||
expect(Date.now() - starttm).toBeLessThan(defaults.limiter.baseIntvl + 100) | ||
limiter.addPass('other') | ||
limiter.addPass('Time') | ||
let expectedIntvl = defaults.limiter.baseIntvl * 0.95 | ||
for (let i = 0; i < 10; i++) { | ||
limiter.attempt('other') | ||
limiter.attempt('Time') | ||
if (i > 4) { | ||
@@ -76,3 +76,3 @@ if (expectedIntvl < 1000) { | ||
starttm = Date.now() | ||
await limiter.attempt('other') | ||
await limiter.attempt('Time') | ||
expect(Date.now() - starttm).toBeGreaterThan(expectedIntvl - 100) | ||
@@ -82,9 +82,9 @@ expect(Date.now() - starttm).toBeLessThan(expectedIntvl + 100) | ||
test('Limits categories correctly', async () => { | ||
jest.setTimeout(60000) | ||
test('Limits public categories correctly', async () => { | ||
jest.setTimeout(180000) | ||
const limiter = loadLimiter(defaults) | ||
let expectedIntvl = defaults.limiter.baseIntvl | ||
for (let i = 0; i < 10; i++) { | ||
limiter.attempt('other') | ||
limiter.addFail('other') | ||
limiter.attempt('Time') | ||
limiter.addFail('Time') | ||
if (expectedIntvl < 4500) { | ||
@@ -96,5 +96,46 @@ expectedIntvl = 4500 | ||
let starttm = Date.now() | ||
await limiter.attempt('other') | ||
await limiter.attempt('Time') | ||
expect(Date.now() - starttm).toBeGreaterThan(expectedIntvl - 100) | ||
expect(Date.now() - starttm).toBeLessThan(expectedIntvl + 100) | ||
expectedIntvl = defaults.limiter.baseIntvl | ||
for (let i = 0; i < 10; i++) { | ||
limiter.attempt('OHLC') | ||
limiter.addFail('OHLC') | ||
if (expectedIntvl < 4500) { | ||
expectedIntvl = 4500 | ||
} | ||
expectedIntvl *= 1.1 | ||
} | ||
starttm = Date.now() | ||
await limiter.attempt('OHLC') | ||
expect(Date.now() - starttm).toBeGreaterThan(expectedIntvl - 100) | ||
expect(Date.now() - starttm).toBeLessThan(expectedIntvl + 100) | ||
expectedIntvl = defaults.limiter.baseIntvl | ||
for (let i = 0; i < 10; i++) { | ||
limiter.attempt('Trades') | ||
limiter.addFail('Trades') | ||
if (expectedIntvl < 4500) { | ||
expectedIntvl = 4500 | ||
} | ||
expectedIntvl *= 1.1 | ||
} | ||
starttm = Date.now() | ||
await limiter.attempt('Trades') | ||
expect(Date.now() - starttm).toBeGreaterThan(expectedIntvl - 100) | ||
expect(Date.now() - starttm).toBeLessThan(expectedIntvl + 100) | ||
}) | ||
test('Limits private calls correctly', async() => { | ||
jest.setTimeout(60000) | ||
const limiter = loadLimiter(defaults) | ||
for (let i = 0; i < 15; i++) { | ||
limiter.attempt('Balance') | ||
limiter.addPass('Balance') | ||
} | ||
const starttm = Date.now() | ||
await limiter.attempt('Ledgers') | ||
expect(Date.now() - starttm).toBeGreaterThan(5800) | ||
expect(Date.now() - starttm).toBeLessThan(6200) | ||
}) |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
275912
3140