Skip to content

Commit a2609db

Browse files
author
Matt Berther
committed
update for formatting consistency
1 parent 090f7a9 commit a2609db

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ npm install winston-daily-rotate-file
1818
The DailyRotateFile transport can rotate files by minute, hour, day, month, year or weekday. In addition to the options accepted by the logger, `winston-daily-rotate-file` also accepts the following options:
1919

2020
* **frequency:** A string representing the frequency of rotation. This is useful if you want to have timed rotations, as opposed to rotations that happen at specific moments in time. Valid values are '#m' or '#h' (e.g., '5m' or '3h'). Leaving this null relies on `datePattern` for the rotation times. (default: null)
21-
* **datePattern:** A string representing the [moment.js date format](http://momentjs.com/docs/#/displaying/format/) to be used for rotating. The meta characters used in this string will dictate the frequency of the file rotation. For example, if your datePattern is simply 'HH' you will end up with 24 log files that are picked up and appended to every day. (default 'YYYY-MM-DD')
22-
* **zippedArchive:** A boolean to define whether or not to gzip archived log files. (default 'false')
21+
* **datePattern:** A string representing the [moment.js date format](http://momentjs.com/docs/#/displaying/format/) to be used for rotating. The meta characters used in this string will dictate the frequency of the file rotation. For example, if your datePattern is simply 'HH' you will end up with 24 log files that are picked up and appended to every day. (default: 'YYYY-MM-DD')
22+
* **zippedArchive:** A boolean to define whether or not to gzip archived log files. (default: 'false')
2323
* **filename:** Filename to be used to log to. This filename can include the `%DATE%` placeholder which will include the formatted datePattern at that point in the filename. (default: 'winston.log.%DATE%)
2424
* **dirname:** The directory name to save log files to. (default: '.')
2525
* **stream:** Write directly to a custom stream and bypass the rotation capabilities. (default: null)
@@ -56,10 +56,10 @@ The DailyRotateFile transport can rotate files by minute, hour, day, month, year
5656

5757
This transport emits the following custom events:
5858

59-
* *new*: fired when a new log file is created. This event will pass one parameter to the callback (*newFilename*).
60-
* *rotate*: fired when the log file is rotated. This event will pass two parameters to the callback (*oldFilename*, *newFilename*).
61-
* *archive*: fired when the log file is archived. This event will pass one parameter to the callback (*zipFilename*).
62-
* *logRemoved*: fired when a log file is removed from the file system. This event will pass one parameter to the callback (*removedFilename*).
59+
* **new**: fired when a new log file is created. This event will pass one parameter to the callback (*newFilename*).
60+
* **rotate**: fired when the log file is rotated. This event will pass two parameters to the callback (*oldFilename*, *newFilename*).
61+
* **archive**: fired when the log file is archived. This event will pass one parameter to the callback (*zipFilename*).
62+
* **logRemoved**: fired when a log file is removed from the file system. This event will pass one parameter to the callback (*removedFilename*).
6363

6464
## LICENSE
6565
MIT

0 commit comments

Comments
 (0)