rallias/Scribe.js
1
0
Fork 0
forked from mirrors/Scribe.js
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update doc

Browse source
This commit is contained in:
Guillaume Wuip 2014-10-29 11:39:25 +01:00
parent 7f8fdc0e47
commit e35260b575
1 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
lib/logWriter.js
View file

@ -67,12 +67,6 @@
* Save console logs on disk * Save console logs on disk
* *
* @constructor * @constructor
*
* @param {Console2} cons A Console2 instance
* @param {Object} opt Logger's options
* @param {String} opt.rootPath Logs folder. Default 'logs'.
* @param {Boolean} opt.start Whether to start to log right now or not. Default true.
* Use false when you want to custom getPath, getFilename, etc.
*/ */
var LogWriter = function () {}; var LogWriter = function () {};
@ -80,7 +74,8 @@
* LogWriter.prototype.getPath * LogWriter.prototype.getPath
* *
* @param {Object} opt params * @param {Object} opt params
* @param {Object} opt.logger The logger * @param {String} opt.rootPath root logs folder
* @param {String} opt.logger logger options
* *
* @return {String} The path to current folder (without rootPath) * @return {String} The path to current folder (without rootPath)
*/ */
@ -98,7 +93,8 @@
* LogWriter.prototype.getFile * LogWriter.prototype.getFile
* *
* @param {Object} opt params * @param {Object} opt params
* @param {Object} opt.logger The logger * @param {String} opt.rootPath root logs folder
* @param {String} opt.logger logger options
* *
* @return {String} the filname (with extension) * @return {String} the filname (with extension)
*/ */
@ -116,7 +112,8 @@
* LogWriter.prototype.path * LogWriter.prototype.path
* *
* @param {Object} opt params * @param {Object} opt params
* @param {Object} opt.logger The logger * @param {String} opt.rootPath root logs folder
* @param {String} opt.logger logger options
* *
* @return {String} the full path to file * @return {String} the full path to file
*/ */
@ -134,8 +131,10 @@
* Save a log on disk * Save a log on disk
* *
* @param {Object} log The log to save * @param {Object} log The log to save
* @param {Object} opti Options *
* @param {Object} opt Options
* @param {String} opt.rootPath root logs folder * @param {String} opt.rootPath root logs folder
* @param {String} opt.logger logger options
*/ */
LogWriter.prototype.save = function (log, opt) { LogWriter.prototype.save = function (log, opt) {
@ -173,5 +172,4 @@
module.exports = LogWriter; module.exports = LogWriter;
}()); }());