diff --git a/docs/transport.asciidoc b/docs/transport.asciidoc index 8901ef251..5939ad5b8 100644 --- a/docs/transport.asciidoc +++ b/docs/transport.asciidoc @@ -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 diff --git a/src/lib/log.js b/src/lib/log.js old mode 100755 new mode 100644 index 137c94281..8501f5b2f --- a/src/lib/log.js +++ b/src/lib/log.js @@ -10,11 +10,12 @@ var EventEmitter = require('events').EventEmitter; * @class Log * @uses Loggers.Stdio * @constructor - * @param {string|Object|ArrayOfStrings|ArrayOfObjects} output - Either the level - * to setup a single logger, a full config object for alogger, or an array of + * @param {object} config + * @param {string|Object|ArrayOfStrings|ArrayOfObjects} config.log - Either the level + * to setup a single logger, a full config object for a logger, or an array of * config objects to use for creating log outputs. - * @param {string} output.level - One of the keys in Log.levels (error, warning, etc.) - * @param {string} output.type - The name of the logger to use for this output + * @param {string|array} config.log.level|config.log.levels - One or more keys in Log.levels (error, warning, etc.) + * @param {string} config.log.type - The name of the logger to use for this output */ function Log(config) { config = config || {}; @@ -196,7 +197,7 @@ Log.join = function (arrayish) { * @param {object} config - An object with config options for the logger. * @param {String} [config.type=stdio] - The name of an output/logger. Options * can be found in the `src/loggers` directory. - * @param {String|ArrayOfStrings} [config.levels=warning] - The levels to output + * @param {String|ArrayOfStrings} [config.level|config.levels=warning] - The levels to output * to this logger, when an array is specified no levels other than the ones * specified will be listened to. When a string is specified, that and all lower * levels will be logged. diff --git a/src/lib/transport.js b/src/lib/transport.js index b90ebc2bb..71aa7bb50 100644 --- a/src/lib/transport.js +++ b/src/lib/transport.js @@ -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)