add options documentation to readme

This commit is contained in:
Erik 2022-11-07 13:49:01 +02:00
parent 4d2572f07d
commit 45ba81a3c0
Signed by: Navy.gif
GPG Key ID: 811EC0CD80E7E5FB

View File

@ -8,4 +8,15 @@ Simple logger I wrote to have a unified system for logging throughout my project
## Features
Split into Master and Client for logging between processes, where master resides on the master process and the clients on the spawned processes.
Should be fairly trivial to modify it to work across nodes with websockets.
Should be fairly trivial to modify it to work across nodes with websockets.
## Logger Options
```
{
customTypes: [], // Log types, defaults are 'error', 'warn', 'info', 'debug', 'status'. Each one of these has an associated shorthand function, the custom ones will receive one too, e.g. adding 'access' to the custom types will add a logger.access() function
customStreams: [], // File streams, by default there are streams for error and default
customTypeMapping: {}, // This maps a type to a stream, e.g. adding "warn": "error" will pipe any warnings to the error log file
customColors: {}, // Supports any colours chalk.js supports, e.g. "warn": "green" will turn warning outputs green
debug: false
}
```