habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix Transport request doc issues.

Browse Source 
(cherry picked from commit 7696e0624a)
This commit is contained in:
Jesse McCarthy
2016-01-08 16:27:36 -05:00
committed by spalger
parent 1f8b506f00
commit 0b72aa760d
2 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/transport.asciidoc
View File

@ -11,9 +11,6 @@
`query`:: `query`::
`Object` -- The query string params `Object` -- The query string params
`path`::
`Object` -- The query string params
`ignore`:: `ignore`::
`Number, Number[]` -- HTTP status codes which should not be treated as errors `Number, Number[]` -- HTTP status codes which should not be treated as errors

7
src/lib/transport.js
View File

@ -122,9 +122,10 @@ Transport.prototype.defer = function () {
* @todo access to custom headers, modifying of request in general * @todo access to custom headers, modifying of request in general
* @param {object} params * @param {object} params
* @param {Number} params.requestTimeout - timeout for the entire request (inculding all retries) * @param {Number} params.requestTimeout - timeout for the entire request (inculding all retries)
* @param {Number} params.maxRetries - number of times the request will be re-run in * @param {Number} params.maxRetries - number of times to re-run request if the
* the original node chosen can not be connected to. * original node chosen can not be connected to.
* @param {String} params.url - The url for the request * @param {string} [params.path="/"] - URL pathname. Do not include query string.
* @param {string|object} [params.query] - Query string.
* @param {String} params.method - The HTTP method for the request * @param {String} params.method - The HTTP method for the request
* @param {String} params.body - The body of the HTTP request * @param {String} params.body - The body of the HTTP request
* @param {Function} cb - A function to call back with (error, responseBody, responseStatus) * @param {Function} cb - A function to call back with (error, responseBody, responseStatus)