numBackups documentation not correct

[jkopczyn]

The switch from daysToKeep to numBackups in #1149 left the documentation out of date, see here and here. It is not clear what the behavior is, or is supposed to be.

[lamweili]

The documentation is correct. Please reference the documentation for now, amidst the confusion.

log4js-node/docs/dateFile.md

Line 20 in 110a008

* `numBackups` - `integer` (default 1) - the number of old files that matches the pattern to keep (excluding the hot file).

The comment in the below typescript definition is outdated. The update to the documentation in #1181 missed this out.

log4js-node/types/log4js.d.ts

Line 191 in 110a008

// if this value is greater than zero, then files older than that many days will be deleted during log rolling.(default 0)

[lamweili]

Might have a few other updates to documentation that is not reflected in the comments in the typescript definition.
I shall indicate PR #1240 as draft till I sieve them out.

[lamweili]

@jkopczyn For clarity, daysToKeep was renamed to numBackups.
numBackups is the number of old backups (excluding the hot file).

The variable name daysToKeep didn't make sense due to some of the examples below (which are not in days):

• pattern='yyyy-MM-dd' and numBackups=5:
  1 hot/current + 5 backup(s) of previous days = 6 file(s)

• pattern='yyyy-MM' and numBackups=0:
  1 hot/current + 0 backup(s) of previous months = 1 file(s)

• pattern='yyyy-MM-dd-hh:mm:ss' and numBackups=30:
  1 hot/current + 30 backup(s) of previous seconds = 31 file(s)

[lamweili]

Fixed in log4js@6.4.7.