Skip to content

docs: clarify log precedence #1043

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vibhor-aggr wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify log precedence #1043

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,9 @@ In Chromium-based web browsers (e.g. Brave, Chrome, and Electron), the JavaScrip

## Output streams

By default `debug` will log to stderr, however this can be configured per-namespace by overriding the `log` method:
By default `debug` will log to stderr. This can be configured globally by
overriding `debug.log`, or per namespace by overriding the namespace's `log`
method. A per-namespace `log` method takes precedence over `debug.log`.

Example _stdout.js_:

Expand All @@ -264,11 +266,11 @@ log.log = console.log.bind(console); // don't forget to bind to console!
log('goes to stdout');
error('still goes to stderr!');

// set all output to go via console.info
// overrides all per-namespace log settings
// set the default output to console.info
// namespaces with their own log method keep using it
debug.log = console.info.bind(console);
error('now goes to stdout via console.info');
log('still goes to stdout, but via console.info now');
log('still goes to stdout via console.log');
```

## Extend
Expand Down