diff --git a/README.md b/README.md index 5eb0265..ce64f28 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ The streams behave the same as standard node.js streams, except that when certai ### new RollingFileStream(filename [, maxSize, numBackups, options]) * `filename` (String) * `maxSize` - the size in bytes to trigger a rollover, if not provided this defaults to MAX_SAFE_INTEGER and the stream will not roll. -* `numBackups` - the number of old files to keep +* `numBackups` - the number of old files to keep (excluding the hot file) * `options` - Object * `encoding` - defaults to 'utf8' * `mode` - defaults to 0644 @@ -51,7 +51,7 @@ When filename size >= maxSize then: * `compress` - (boolean) compress the backup files, defaults to false * `keepFileExt` - (boolean) defaults to `false` - keep the file original extension. e.g.: `abc.log -> abc.2013-08-30.log`. * `alwaysIncludePattern` - (boolean) extend the initial file with the pattern, defaults to false - * `daysToKeep` - (integer) if this is greater than 0, then files older than `daysToKeep` days will be deleted during file rolling. + * `daysToKeep` - (integer) the number of old files that matches the pattern to keep (excluding the hot file) This returns a `WritableStream`. When the current time, formatted as `pattern`, changes then the current file will be renamed to `filename.formattedDate` where `formattedDate` is the result of processing the date through the pattern, and a new file will begin to be written. Streamroller uses [date-format](http://github.com/nomiddlename/date-format) to format dates, and the `pattern` should use the date-format format. e.g. with a `pattern` of `".yyyy-MM-dd"`, and assuming today is August 29, 2013 then writing to the stream today will just write to `filename`. At midnight (or more precisely, at the next file write after midnight), `filename` will be renamed to `filename.2013-08-29` and a new `filename` will be created. If `options.alwaysIncludePattern` is true, then the initial file will be `filename.2013-08-29` and no renaming will occur at midnight, but a new file will be written to with the name `filename.2013-08-30`.