Skip to content

Commit 44afd67

Browse files
doc: add a note on console stream behavior
Many user reported issues show poor awareness of the nature of console streams. explicitly document that. PR-URL: #55616 Reviewed-By: Ulises Gascón <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent ba8fc73 commit 44afd67

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

doc/api/console.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@ The module exports two specific components:
1919

2020
_**Warning**_: The global console object's methods are neither consistently
2121
synchronous like the browser APIs they resemble, nor are they consistently
22-
asynchronous like all other Node.js streams. See the [note on process I/O][] for
22+
asynchronous like all other Node.js streams. Programs that desire to depend
23+
on the synchronous / asynchronous behavior of the console functions should
24+
first figure out the nature of console's backing stream. This is because the
25+
stream is dependent on the underlying platform and standard stream
26+
configuration of the current process. See the [note on process I/O][] for
2327
more information.
2428

2529
Example using the global `console`:

0 commit comments

Comments
 (0)