Skip to content

doc: util.debuglog callback #33856

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
bmeck wants to merge 7 commits into from
Closed

doc: util.debuglog callback #33856

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
90cd514
doc: util.debuglog callback
bmeck Jun 12, 2020
926ded7
Update doc/api/util.md
bmeck Jun 12, 2020
8e6ea1d
Update doc/api/util.md
bmeck Jun 12, 2020
0c43e20
Update doc/api/util.md
bmeck Jun 15, 2020
02d5ab3
Update doc/api/util.md
bmeck Jun 15, 2020
10727dc
Update doc/api/util.md
bmeck Jun 15, 2020
fe7ae70
Update doc/api/util.md
bmeck Jun 15, 2020
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
Prev Previous commit
Next Next commit
Update doc/api/util.md
  • Loading branch information
@bmeck
bmeck authored Jun 12, 2020
commit 8e6ea1d90218038ea6b385a3de0fe7405811a97e
23 changes: 7 additions & 16 deletions doc/api/util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,27 +121,18 @@ FOO-BAR 3257: hi there, it's foo-bar [2333]
Multiple comma-separated `section` names may be specified in the `NODE_DEBUG`
environment variable: `NODE_DEBUG=fs,net,tls`.

The optional `callback` argument can be used to perform logic depending on if
a section is enabled.
The optional `callback` argument can be used to replace the logging function
with a different function that doesn't have any initialization or
unnecessary wrapping.

```js
const util = require('util');
let makeInternalsPublic = false;
Comment thread
bmeck marked this conversation as resolved.
Outdated
const debug = util.debuglog('internals', (debug) => {
makeInternalsPublic = debug !== null;
const debuglog = util.debuglog('internals', (debug) => {
Comment thread
bmeck marked this conversation as resolved.
Outdated
// replace with a logging function that optimizes out
Comment thread
bmeck marked this conversation as resolved.
Outdated
// testing if the section is enabled
debuglog = debug;
});
let counter = 1;
debug('exposing internals, do not use them as a public API');
module.exports = {
internal: makeInternalsPublic ? {
setCounter(newValue) {
counter = newValue;
}
} : null,
nextValue() {
return counter++;
}
};
```

## `util.deprecate(fn, msg[, code])`
Expand Down