Skip to content

Commit 83a12b7

Browse files
committed
docs: add LogConsumer class and enabled method documentation
1 parent 8f88a71 commit 83a12b7

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

doc/api/logger.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,33 @@
88

99
The `node:logger` module provides structured logging capabilities for Node.js
1010
applications.
11+
12+
## Class: `LogConsumer`
13+
14+
### `consumer.enabled(level)`
15+
16+
<!-- YAML
17+
added: REPLACEME
18+
-->
19+
20+
* `level` {string} The log level to check (e.g., `'debug'`, `'info'`, `'warn'`,
21+
`'error'`, `'fatal'`).
22+
* Returns: {boolean} `true` if the level is enabled, `false` otherwise.
23+
24+
Checks if a specific log level is enabled for this consumer.
25+
26+
This method returns `false` for unknown log levels without throwing an error.
27+
Log levels are case-sensitive and must be one of the predefined levels:
28+
`'trace'`, `'debug'`, `'info'`, `'warn'`, `'error'`, `'fatal'`.
29+
30+
```js
31+
const { LogConsumer } = require('node:logger');
32+
33+
const consumer = new LogConsumer({ level: 'info' });
34+
35+
console.log(consumer.enabled('debug')); // false (below threshold)
36+
console.log(consumer.enabled('info')); // true
37+
console.log(consumer.enabled('error')); // true
38+
console.log(consumer.enabled('DEBUG')); // false (unknown level - case sensitive)
39+
console.log(consumer.enabled('unknown')); // false (unknown level)
40+
```

0 commit comments

Comments
 (0)