🐨 ConsolaElegant Console Logger for Node.js and Browser
- Easy to use
- Fancy output with fallback for minimal environments
- Pluggable reporters
- Consistent command line interface (CLI) experience
- Tag support
stdout/stderrto the consola and easily restore redirect.
- Browser support
- Pause/Resume support
- Mocking support
- Spam prevention by throttling logs
yarn add consola
npm i consola
const consola =// See types section for all available typesconsolaconsolaconsola
Will display in the terminal:
NOTE: Alternatively, you can import consola from source. But don't forget to whitelist it for transpilation:
Log to all reporters.
A list of available types can be found here.
Register a custom reporter instance.
Remove a registered reporter.
If no arguments are passed all reporters will be removed.
Replace all reporters.
Create a new
Consola instance and inherit all parent options for defaults.
Create a new
Consola instance with provided defaults
Create a new
Consola instance with that tag.
Globally redirect all
console.log, etc calls to consola handlers.
Globally redirect all stdout/stderr outputs to consola.
Wrap both, std and console.
console uses std in the underlying so calling
wrapStd redirects console too.
Benefit of this function is that things like
console.info will be correctly redirected to the corresponding type.
Globally pause and resume logs.
Consola will enqueue all logs when paused and then sends them to the reported when resumed.
Mock all types. Useful for using with tests.
The first argument passed to
mockTypes should be a callback function accepting
(typeName, type) and returning the mocked value:
Please note that with the example above, everything is mocked independently for each type. If you need one mocked fn create it outside:
const fn = jestconsola
If callback function returns a falsy value, that type won't be mocked.
For example if you just need to mock
NOTE: Any instance of consola that inherits the mocked instance, will apply provided callback again.
This way, mocking works for
withTag scoped loggers without need to extra efforts.
An array of active reporters.
The level to display logs. Any logs at or above this level will be displayed. List of available levels here.
You can set log level using
CONSOLA_LEVEL environment variable.
logObject is a free-to-extend object which will be passed to reporters.
Choose between one of the built-in reporters or bring in your own one.
FancyReporter is registered for modern terminals or
BasicReporter will be used if running in limited environments such as CIs.
Creating your own reporter
A reporter (class or object) exposes
To get more info about how to write your own reporter, take a look into the linked implementations above.
Types are used to actually log messages to the reporters. Each type is attached to a logging level.
A list of all available default types is here.
Creating a new instance
Consola has a global instance and is recommended to use everywhere. In case more control is needed, create a new instance.
const logger = consola
MIT - Made with 💖 By Nuxt.js team!