feat: expose request options in REST constructor. Fix readme links.

This commit is contained in:
tiagosiebler
2020-10-08 22:05:22 +01:00
parent df576407b4
commit 1c14595fd6
3 changed files with 27 additions and 16 deletions

View File

@@ -4,8 +4,16 @@ const assert = require('assert');
const RequestWrapper = require('./util/requestWrapper');
module.exports = class RestClient {
constructor(key, secret, livenet=false, options={}) {
/**
* @public Creates an instance of the inverse REST API client.
*
* @param {string} key - your API key
* @param {string} secret - your API secret
* @param {boolean} [livenet=false]
* @param {*} [options={}] options to configure REST API connectivity
* @param {*} [requestOptions={}] HTTP networking options for axios
*/
constructor(key, secret, livenet=false, options={}, requestOptions={}) {
this.request = new RequestWrapper(...arguments);
}