8000 docs(configure): configure(...) docs appended with "returning value". · xyz-data/log4js-node@5d276a4 · GitHub
[go: up one dir, main page]

Skip to content

Commit 5d276a4

Browse files
committed
docs(configure): configure(...) docs appended with "returning value".
1 parent 9f5b7be commit 5d276a4

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/api.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ If you are using `cluster`, then include the call to `configure` in the worker p
1010

1111
Configuration objects must define at least one appender, and a default category. Log4js will throw an exception if the configuration is invalid.
1212

13+
`configure` method call returns the configured log4js object.
14+
1315
### Configuration Object
1416
Properties:
1517
* `levels` (optional, object) - used for defining custom log levels, or redefining existing ones; this is a map with the level name as the key (string, case insensitive), and an object as the value. The object should have two properties: the level value (integer) as the value, and the colour. Log levels are used to assign importance to log messages, with the integer value being used to sort them. If you do not specify anything in your configuration, the default values are used (ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < MARK < OFF - note that OFF is intended to be used to turn off logging, not as a level for actual logging, i.e. you would never call `logger.off('some log message')`). Levels defined here are used in addition to the default levels, with the integer value being used to determine their relation to the default levels. If you define a level with the same name as a default level, then the integer value in the config takes precedence. Level names must begin with a letter, and can only contain letters, numbers and underscores.

0 commit comments

Comments
 (0)
0