Commit c842146
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 <ulisesgascongonzalez@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent 1978285 commit c842146
1 file changed
Lines changed: 5 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -19,7 +19,11 @@ The module exports two specific components: | |||
| 19 | 19 | ||
| 20 | 20 | _**Warning**_: The global console object's methods are neither consistently | |
| 21 | 21 | 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 | ||
| 23 | 27 | more information. | |
| 24 | 28 | ||
| 25 | 29 | Example using the global `console`: | |
0 commit comments