Skip to content

Commit 1a3dfda

Browse files
authored
README: clarify DEBUG_ envvar parsing
1 parent 3f56313 commit 1a3dfda

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -171,9 +171,15 @@ change the behavior of the debug logging:
171171
| `DEBUG_DEPTH` | Object inspection depth. |
172172
| `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. |
173173

174-
175-
__Note:__ The environment variables beginning with `DEBUG_` end up being
174+
__Note:__ Any environment variables beginning with `DEBUG_` end up being
176175
converted into an Options object that gets used with `%o`/`%O` formatters.
176+
177+
To set these variables, you can use the following string values:
178+
- one of "yes", "on", "true", "enabled": `true`
179+
- one of "no", "off", "false", "disabled": `false`
180+
- "null": `null`
181+
- anything else is parsed as a number
182+
177183
See the Node.js documentation for
178184
[`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options)
179185
for the complete list.

0 commit comments

Comments
 (0)