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

Corrections to log source docs.

Browse Source
This commit is contained in:
Jesse McCarthy
2016-01-08 17:05:04 -05:00
parent 0e3fe1586f
commit 2d92f3268e
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/lib/log.js Executable file → Normal file
View File

@ -10,11 +10,12 @@ var EventEmitter = require('events').EventEmitter;
* @class Log * @class Log
* @uses Loggers.Stdio * @uses Loggers.Stdio
* @constructor * @constructor
* @param {string|Object|ArrayOfStrings|ArrayOfObjects} output - Either the level * @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 * to setup a single logger, a full config object for a logger, or an array of
* config objects to use for creating log outputs. * config objects to use for creating log outputs.
* @param {string} output.level - One of the keys in Log.levels (error, warning, etc.) * @param {string|array} config.log.level|config.log.levels - One or more keys in Log.levels (error, warning, etc.)
* @param {string} output.type - The name of the logger to use for this output * @param {string} config.log.type - The name of the logger to use for this output
*/ */
function Log(config) { function Log(config) {
config = config || {}; config = config || {};
@ -196,7 +197,7 @@ Log.join = function (arrayish) {
* @param {object} config - An object with config options for the logger. * @param {object} config - An object with config options for the logger.
* @param {String} [config.type=stdio] - The name of an output/logger. Options * @param {String} [config.type=stdio] - The name of an output/logger. Options
* can be found in the `src/loggers` directory. * 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 * 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 * specified will be listened to. When a string is specified, that and all lower
* levels will be logged. * levels will be logged.