Skip to content

Commit 24976bf

Browse files
mfdebiantargos
authored andcommittedOct 2, 2024
doc: add esm examples to node:console
PR-URL: #54108 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jake Yuesong Li <jake.yuesong@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent c61cee2 commit 24976bf

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed
 

‎doc/api/console.md

+27-2
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,11 @@ The `Console` class can be used to create a simple logger with configurable
8080
output streams and can be accessed using either `require('node:console').Console`
8181
or `console.Console` (or their destructured counterparts):
8282

83-
```js
83+
```mjs
84+
import { Console } from 'node:console';
85+
```
86+
87+
```cjs
8488
const { Console } = require('node:console');
8589
```
8690

@@ -132,7 +136,28 @@ Creates a new `Console` with one or two writable stream instances. `stdout` is a
132136
writable stream to print log or info output. `stderr` is used for warning or
133137
error output. If `stderr` is not provided, `stdout` is used for `stderr`.
134138

135-
```js
139+
```mjs
140+
import { createWriteStream } from 'node:fs';
141+
import { Console } from 'node:console';
142+
// Alternatively
143+
// const { Console } = console;
144+
145+
const output = createWriteStream('./stdout.log');
146+
const errorOutput = createWriteStream('./stderr.log');
147+
// Custom simple logger
148+
const logger = new Console({ stdout: output, stderr: errorOutput });
149+
// use it like console
150+
const count = 5;
151+
logger.log('count: %d', count);
152+
// In stdout.log: count 5
153+
```
154+
155+
```cjs
156+
const fs = require('node:fs');
157+
const { Console } = require('node:console');
158+
// Alternatively
159+
// const { Console } = console;
160+
136161
const output = fs.createWriteStream('./stdout.log');
137162
const errorOutput = fs.createWriteStream('./stderr.log');
138163
// Custom simple logger

0 commit comments

Comments
 (0)
Please sign in to comment.