rename rest client options to be more generic

This commit is contained in:
tiagosiebler
2021-02-14 16:29:35 +00:00
parent 3b2af548d0
commit 26602cfa05
4 changed files with 30 additions and 31 deletions

View File

@@ -1,5 +1,5 @@
import { AxiosRequestConfig } from 'axios';
import { GenericAPIResponse, getBaseRESTInverseUrl, RestClientInverseOptions } from './util/requestUtils';
import { GenericAPIResponse, getRestBaseUrl, RestClientOptions } from './util/requestUtils';
import RequestWrapper from './util/requestWrapper';
import SharedEndpoints from './shared-endpoints';
@@ -12,23 +12,23 @@ export class InverseClient extends SharedEndpoints {
* @param {string} key - your API key
* @param {string} secret - your API secret
* @param {boolean} [useLivenet=false]
* @param {RestClientInverseOptions} [restInverseOptions={}] options to configure REST API connectivity
* @param {RestClientOptions} [restInverseOptions={}] options to configure REST API connectivity
* @param {AxiosRequestConfig} [requestOptions={}] HTTP networking options for axios
*/
constructor(
key?: string | undefined,
secret?: string | undefined,
useLivenet?: boolean,
restInverseOptions: RestClientInverseOptions = {},
httpOptions: AxiosRequestConfig = {}
restInverseOptions: RestClientOptions = {},
requestOptions: AxiosRequestConfig = {}
) {
super()
this.requestWrapper = new RequestWrapper(
key,
secret,
getBaseRESTInverseUrl(useLivenet),
getRestBaseUrl(useLivenet),
restInverseOptions,
httpOptions
requestOptions
);
return this;
}

View File

@@ -1,5 +1,5 @@
import { AxiosRequestConfig } from 'axios';
import { GenericAPIResponse, getBaseRESTInverseUrl, RestClientInverseOptions } from './util/requestUtils';
import { GenericAPIResponse, getRestBaseUrl, RestClientOptions } from './util/requestUtils';
import RequestWrapper from './util/requestWrapper';
import SharedEndpoints from './shared-endpoints';
@@ -11,23 +11,22 @@ export class LinearClient extends SharedEndpoints {
*
* @param {string} key - your API key
* @param {string} secret - your API secret
* @param {boolean} [livenet=false]
* @param {RestClientInverseOptions} [restInverseOptions={}] options to configure REST API connectivity
* @param {boolean} [useLivenet=false]
* @param {RestClientOptions} [restInverseOptions={}] options to configure REST API connectivity
* @param {AxiosRequestConfig} [requestOptions={}] HTTP networking options for axios
*/
constructor(
key?: string | undefined,
secret?: string | undefined,
livenet?: boolean,
restInverseOptions:RestClientInverseOptions = {}, // TODO: Rename this type to be more general.
useLivenet?: boolean,
restInverseOptions: RestClientOptions = {},
requestOptions: AxiosRequestConfig = {}
) {
super()
this.requestWrapper = new RequestWrapper(
key,
secret,
getBaseRESTInverseUrl(livenet),
getRestBaseUrl(useLivenet),
restInverseOptions,
requestOptions
);
@@ -46,7 +45,7 @@ export class LinearClient extends SharedEndpoints {
from: number;
limit?: number;
}): GenericAPIResponse {
return this.requestWrapper.get('/public/linear/kline', params);
return this.requestWrapper.get('public/linear/kline', params);
}
/**

View File

@@ -1,6 +1,6 @@
import { createHmac } from 'crypto';
export interface RestClientInverseOptions {
export interface RestClientOptions {
// override the max size of the request window (in ms)
recv_window?: number;
@@ -42,7 +42,7 @@ export function serializeParams(params: object = {}, strict_validation = false):
.join('&');
};
export function getBaseRESTInverseUrl(useLivenet?: boolean, restInverseOptions?: RestClientInverseOptions) {
export function getRestBaseUrl(useLivenet?: boolean, restInverseOptions?: RestClientOptions) {
const baseUrlsInverse = {
livenet: 'https://api.bybit.com',
testnet: 'https://api-testnet.bybit.com'

View File

@@ -1,11 +1,11 @@
import axios, { AxiosRequestConfig, AxiosResponse, Method } from 'axios';
import { signMessage, serializeParams, RestClientInverseOptions, GenericAPIResponse, isPublicEndpoint } from './requestUtils';
import { signMessage, serializeParams, RestClientOptions, GenericAPIResponse, isPublicEndpoint } from './requestUtils';
export default class RequestUtil {
private timeOffset: number | null;
private syncTimePromise: null | Promise<any>;
private options: RestClientInverseOptions;
private options: RestClientOptions;
private baseUrl: string;
private globalRequestOptions: AxiosRequestConfig;
private key: string | undefined;
@@ -15,7 +15,7 @@ export default class RequestUtil {
key: string | undefined,
secret: string | undefined,
baseUrl: string,
options: RestClientInverseOptions = {},
options: RestClientOptions = {},
requestOptions: AxiosRequestConfig = {}
) {
this.timeOffset = null;