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

Merge pull request #334 from jmm/transport-api-docs

Browse Source 
Fix Transport request doc issues.
This commit is contained in:
Spencer
2016-01-10 14:08:04 -07:00
parent b48ec5c91c 7696e0624a
commit 843265328f
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`::
`Object` -- The query string params
`path`::
`Object` -- The query string params
`ignore`::
`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
* @param {object} params
* @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
* the original node chosen can not be connected to.
* @param {String} params.url - The url for the request
* @param {Number} params.maxRetries - number of times to re-run request if the
* original node chosen can not be connected to.
* @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.body - The body of the HTTP request
* @param {Function} cb - A function to call back with (error, responseBody, responseStatus)