Merge pull request #1149 from log4js-node/migrate-daysToKeep-to-numBackups

lamweili · web-flow · commit 53248cd564f6 · 2022-01-19T23:33:19.000+08:00
chore(deps): migrated from daysToKeep to numBackups due to streamroller@^3.0.0
diff --git a/docs/dateFile.md b/docs/dateFile.md
@@ -15,7 +15,7 @@ Any other configuration parameters will be passed to the underlying [streamrolle
 * `flags` - `string` (default 'a')
 * `compress` - `boolean` (default false) - compress the backup files during rolling (backup files will have `.gz` extension)
 * `alwaysIncludePattern` - `boolean` (default false) - include the pattern in the name of the current log file as well as the backups.
-* `daysToKeep` - `integer` (default 0) - if this value is greater than zero, then files older than that many days will be deleted during log rolling.
+* `numBackups` - `integer` (default 0) - if this value is greater than zero, then files older than that many days will be deleted during log rolling.
 * `keepFileExt` - `boolean` (default false) - preserve the file extension when rotating log files (`file.log` becomes `file.2017-05-30.log` instead of `file.log.2017-05-30`).
 
 The `pattern` is used to determine when the current log file should be renamed and a new log file created. For example, with a filename of 'cheese.log', and the default pattern of `.yyyy-MM-dd` - on startup this will result in a file called `cheese.log` being created and written to until the next write after midnight. When this happens, `cheese.log` will be renamed to `cheese.log.2017-04-30` and a new `cheese.log` file created. The appender uses the [date-format](https://github.com/nomiddlename/date-format) library to parse the `pattern`, and any of the valid formats can be used. Also note that there is no timer controlling the log rolling - changes in the pattern are determined on every log write. If no writes occur, then no log rolling will happen. If your application logs infrequently this could result in no log file being written for a particular time period.
diff --git a/examples/date-file-rolling.js b/examples/date-file-rolling.js
@@ -5,7 +5,7 @@ const log4js = require('../lib/log4js');
 log4js.configure({
   appenders: {
     file: {
-      type: 'dateFile', filename: 'thing.log', daysToKeep: 3, pattern: '.mm'
+      type: 'dateFile', filename: 'thing.log', numBackups: 3, pattern: '.mm'
     }
   },
   categories: {
diff --git a/types/log4js.d.ts b/types/log4js.d.ts
@@ -189,7 +189,7 @@ export interface DateFileAppender {
   // keep the file extension when rotating logs
   keepFileExt?: boolean;
   // if this value is greater than zero, then files older than that many days will be deleted during log rolling.(default 0)
-  daysToKeep?: number;
+  numBackups?: number;
 }
 
 export interface LogLevelFilterAppender {

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ const log4js = require('../lib/log4js');`
`5`	`5`	`log4js.configure({`
`6`	`6`	`appenders: {`
`7`	`7`	`file: {`
`8`		`- type: 'dateFile', filename: 'thing.log', daysToKeep: 3, pattern: '.mm'`
	`8`	`+ type: 'dateFile', filename: 'thing.log', numBackups: 3, pattern: '.mm'`
`9`	`9`	`}`
`10`	`10`	`},`
`11`	`11`	`categories: {`
Original file line number	Diff line number	Diff line change
`@@ -189,7 +189,7 @@ export interface DateFileAppender {`
`189`	`189`	`// keep the file extension when rotating logs`
`190`	`190`	`keepFileExt?: boolean;`
`191`	`191`	`// if this value is greater than zero, then files older than that many days will be deleted during log rolling.(default 0)`
`192`		`- daysToKeep?: number;`
	`192`	`+ numBackups?: number;`
`193`	`193`	`}`
`194`	`194`
`195`	`195`	`export interface LogLevelFilterAppender {`