Merge pull request #1242 from log4js-node/update-docs

chore(docs): updated usage of units for maxLogSize
log4js-node · May 12, 2022 · 97aeef6 · 97aeef6
2 parents 313553e + c0de051
commit 97aeef6
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/file.md b/docs/file.md
@@ -7,6 +7,7 @@ The file appender writes log events to a file. It supports an optional maximum f
 * `type` - `"file"`
 * `filename` - `string` - the path of the file where you want your logs written.
 * `maxLogSize` - `integer` (optional, defaults to MAX_SAFE_INTEGER) - the maximum size (in bytes) for the log file.
+                                                                      `maxLogSize` can also accept `string` with the size suffixes: ***K***, ***M***, ***G*** such as `1K`, `1M`, `1G`.
 * `backups` - `integer` (optional, defaults to 5) - the number of old log files to keep during log rolling (excluding the hot file).
 * `layout` - (optional, defaults to basic layout) - see [layouts](layouts.md)
 

diff --git a/docs/fileSync.md b/docs/fileSync.md
@@ -6,7 +6,8 @@ The sync file appender writes log events to a file, the only difference to the n
 
 * `type` - `"fileSync"`
 * `filename` - `string` - the path of the file where you want your logs written.
-* `maxLogSize` - `integer` (optional) - the maximum size (in bytes) for the log file. If not specified or 0, then no log rolling will happen.
+* `maxLogSize` - `integer` (optional, defaults to undefined) - the maximum size (in bytes) for the log file. If not specified or 0, then no log rolling will happen.
+                                                               `maxLogSize` can also accept `string` with the size suffixes: ***K***, ***M***, ***G*** such as `1K`, `1M`, `1G`.
 * `backups` - `integer` (optional, defaults to 5) - the number of old log files to keep during log rolling (excluding the hot file).
 * `layout` - (optional, defaults to basic layout) - see [layouts](layouts.md)