Skip to content

Commit b0ea916

Browse files
committedAug 9, 2021
Add doc: explain which files will be deleted when the maxFiles parameter is set
This will make it less confusing for developers.
1 parent aa46174 commit b0ea916

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed
 

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The DailyRotateFile transport can rotate files by minute, hour, day, month, year
2626
* **dirname:** The directory name to save log files to. (default: '.')
2727
* **stream:** Write directly to a custom stream and bypass the rotation capabilities. (default: null)
2828
* **maxSize:** Maximum size of the file after which it will rotate. This can be a number of bytes, or units of kb, mb, and gb. If using the units, add 'k', 'm', or 'g' as the suffix. The units need to directly follow the number. (default: null)
29-
* **maxFiles:** Maximum number of logs to keep. If not set, no logs will be removed. This can be a number of files or number of days. If using days, add 'd' as the suffix. (default: null)
29+
* **maxFiles:** Maximum number of logs to keep. If not set, no logs will be removed. This can be a number of files or number of days. If using days, add 'd' as the suffix. It uses auditFile to keep track of the log files in a json format. It won't delete any file not contained in it. It can be a number of files or number of days (default: null)
3030
* **options:** An object resembling https://nodejs.org/api/fs.html#fs_fs_createwritestream_path_options indicating additional options that should be passed to the file stream. (default: `{ flags: 'a' }`)
3131
* **auditFile**: A string representing the name of the audit file. This can be used to override the default filename which is generated by computing a hash of the options object. (default: '.<optionsHash>.json')
3232
* **utc**: Use UTC time for date in filename. (default: false)

0 commit comments

Comments
 (0)
Please sign in to comment.