update jsdocs and readme

janis-commerce · Jul 22, 2021 · 72c23a8 · 72c23a8
1 parent dc0e740
commit 72c23a8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -259,5 +259,5 @@ If you want to keep the functionality of v1.x must require and change `RequestSa
 const Request = require('@janiscommerce/request');
 
 // new way
-const { Request } = require('@janiscommerce/request');
+const { RequestSafe } = require('@janiscommerce/request');
 ```
diff --git a/lib/request.js b/lib/request.js
@@ -75,8 +75,6 @@ module.exports = class Request {
 	/**
 	 * To get default request headers
 	 *
-	 * @readonly
-	 * @static
 	 */
 	static get defaultHeaders() {
 		return defaultHeaders;
@@ -85,8 +83,6 @@ module.exports = class Request {
 	/**
 	 * To get request http method
 	 *
-	 * @readonly
-	 * @static
 	 */
 	static get httpMethod() {
 		return this.response.originRequest.method;
@@ -95,8 +91,6 @@ module.exports = class Request {
 	/**
 	 * To get request endopoint
 	 *
-	 * @readonly
-	 * @static
 	 */
 	static get endpoint() {
 		return this.response.originRequest.endpoint;
@@ -105,8 +99,6 @@ module.exports = class Request {
 	/**
 	 * To get request headers
 	 *
-	 * @readonly
-	 * @static
 	 */
 	static get headers() {
 		return this.response.originRequest.headers;
@@ -115,8 +107,6 @@ module.exports = class Request {
 	/**
 	 * To get request body
 	 *
-	 * @readonly
-	 * @static
 	 */
 	static get body() {
 		return this.response.originRequest.body;
@@ -125,8 +115,6 @@ module.exports = class Request {
 	/**
 	 * To get response status code
 	 *
-	 * @readonly
-	 * @static
 	 */
 	static get statusCode() {
 		return this.response.statusCode;
@@ -135,8 +123,6 @@ module.exports = class Request {
 	/**
 	 * To get response headers
 	 *
-	 * @readonly
-	 * @static
 	 */
 	static get responseHeaders() {
 		return this.response.headers;
@@ -145,8 +131,6 @@ module.exports = class Request {
 	/**
 	 * To get response body
 	 *
-	 * @readonly
-	 * @static
 	 */
 	static get responseBody() {
 		return this.response.body;
@@ -155,8 +139,6 @@ module.exports = class Request {
 	/**
 	 * Get the safe mode value
 	 *
-	 * @readonly
-	 * @static
 	 */
 	static get safeMode() {
 		return false;
@@ -165,7 +147,6 @@ module.exports = class Request {
 	/**
 	 * To make a GET request
 	 *
-	 * @static
 	 * @param {string} endpoint
 	 * @param {RequestOptions} [options={}]
 	 * @returns {Promise<RequestResponse>}
@@ -177,7 +158,6 @@ module.exports = class Request {
 	/**
 	 * To make a POST request
 	 *
-	 * @static
 	 * @param {string} endpoint
 	 * @param {*} body
 	 * @param {RequestOptions} [options={}]
@@ -190,7 +170,6 @@ module.exports = class Request {
 	/**
 	 * To make a PUT request
 	 *
-	 * @static
 	 * @param {string} endpoint
 	 * @param {*} body
 	 * @param {RequestOptions} [options={}]
@@ -203,7 +182,6 @@ module.exports = class Request {
 	/**
 	 * To make a PATCH request
 	 *
-	 * @static
 	 * @param {string} endpoint
 	 * @param {*} body
 	 * @param {RequestOptions} [options={}]
@@ -216,7 +194,6 @@ module.exports = class Request {
 	/**
 	 * To make a DELETE request
 	 *
-	 * @static
 	 * @param {string} endpoint
 	 * @param {RequestOptions} [options={}]
 	 * @returns {Promise<RequestResponse>}
@@ -228,7 +205,6 @@ module.exports = class Request {
 	/**
 	 * To make a custom request
 	 *
-	 * @static
 	 * @param {object} params CallOptions params
 	 * @param {*} body
 	 * @param {boolean} strictMode
@@ -256,13 +232,12 @@ module.exports = class Request {
 	/**
 	 * To make a custom request
 	 *
-	 * @static
 	 * @param {CallOptions} options
 	 * @returns {Promise<RequestResponse>}
 	 */
 	static async call({ body, strictMode, ...params }) {
 
-		const response = await Request.makeRequest(params, body, strictMode);
+		const response = await this.makeRequest(params, body, strictMode);
 
 		if(!this.safeMode && this.statusCode >= 400)
 			throw new RequestError(`Request failed: ${this.responseBody}`, RequestError.codes.REQUEST_ERROR);
@@ -273,7 +248,6 @@ module.exports = class Request {
 	/**
 	 * The request callback function
 	 *
-	 * @static
 	 * @param {object} res Response from node request
 	 * @param {function} resolve Master promise resolve function
 	 * @param {function} reject Master promise reject function