Skip to content

Commit 17387b6

Browse files
committed
Update httpRequest.js
1 parent b39c138 commit 17387b6

File tree

1 file changed

+2
-14
lines changed

1 file changed

+2
-14
lines changed

src/cloud-code/httpRequest.js

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ const encodeBody = function ({ body, headers = {} }) {
8282
*
8383
* @method httpRequest
8484
* @name Parse.Cloud.httpRequest
85-
* @param {Parse.Cloud.HTTPOptions} options The Parse.Cloud.HTTPOptions object that makes the request.
86-
* @return {Promise<Parse.Cloud.HTTPResponse>} A promise that will be resolved with a {@link Parse.Cloud.HTTPResponse} object when the request completes.
85+
* @param {Object} options axios object for options
86+
* @return {Promise<Object>} axios response object
8787
*/
8888
import axios from 'axios';
8989
import { parse as qs } from 'querystring';
@@ -196,16 +196,4 @@ module.exports.legacy = function httpRequest(options) {
196196
});
197197
};
198198

199-
/**
200-
* @typedef Parse.Cloud.HTTPOptions
201-
* @property {String|Object} body The body of the request. If it is a JSON object, then the Content-Type set in the headers must be application/x-www-form-urlencoded or application/json. You can also set this to a {@link Buffer} object to send raw bytes. If you use a Buffer, you should also set the Content-Type header explicitly to describe what these bytes represent.
202-
* @property {function} error The function that is called when the request fails. It will be passed a Parse.Cloud.HTTPResponse object.
203-
* @property {Boolean} followRedirects Whether to follow redirects caused by HTTP 3xx responses. Defaults to false.
204-
* @property {Object} headers The headers for the request.
205-
* @property {String} method The method of the request. GET, POST, PUT, DELETE, HEAD, and OPTIONS are supported. Will default to GET if not specified.
206-
* @property {String|Object} params The query portion of the url. You can pass a JSON object of key value pairs like params: {q : 'Sean Plott'} or a raw string like params:q=Sean Plott.
207-
* @property {function} success The function that is called when the request successfully completes. It will be passed a Parse.Cloud.HTTPResponse object.
208-
* @property {string} url The url to send the request to.
209-
*/
210-
211199
module.exports.encodeBody = encodeBody;

0 commit comments

Comments
 (0)