Skip to content

docs: note empty DEBUG behavior #1044

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

Closed
vibhor-aggr wants to merge 1 commit into from
Closed

docs: note empty DEBUG behavior #1044

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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,10 @@ change the behavior of the debug logging:
| `DEBUG_DEPTH` | Object inspection depth. |
| `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. |

If `DEBUG` is set to an empty value, `debug` treats it the same as disabling all
namespaces and removes `process.env.DEBUG` when it saves that disabled state.
Use a non-empty disabled value such as `DEBUG=,` when other code must still be
able to observe that the environment variable was set.

__Note:__ The environment variables beginning with `DEBUG_` end up being
converted into an Options object that gets used with `%o`/`%O` formatters.
Expand Down