Commit df1d988
doc: explain common.restore* functions
Explain that `common.restoreStderr()` and `common.restoreStdout()` are
for use with `common.hijackStderr()` and `common.hijackStdout()`
respectively.
PR-URL: #15720
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>1 parent 995948a commit df1d988
1 file changed
Lines changed: 6 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -323,11 +323,13 @@ Deletes the 'tmp' dir and recreates it | |||
| 323 | 323 | ||
| 324 | 324 | ### restoreStderr() | |
| 325 | 325 | ||
| 326 | - Restore the original `process.stderr.write`. | ||
| 326 | + Restore the original `process.stderr.write`. Used to restore `stderr` to its | ||
| 327 | + original state after calling [`common.hijackStdErr()`][]. | ||
| 327 | 328 | ||
| 328 | 329 | ### restoreStdout() | |
| 329 | 330 | ||
| 330 | - Restore the original `process.stdout.write`. | ||
| 331 | + Restore the original `process.stdout.write`. Used to restore `stdout` to its | ||
| 332 | + original state after calling [`common.hijackStdOut()`][]. | ||
| 331 | 333 | ||
| 332 | 334 | ### rootDir | |
| 333 | 335 | * return [<String>] | |
@@ -456,4 +458,6 @@ implementation with tests from | |||
| 456 | 458 | [<Object>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object | |
| 457 | 459 | [<RegExp>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp | |
| 458 | 460 | [<String>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type | |
| 461 | + [`common.hijackStdErr()`]: #hijackstderrlistener | ||
| 462 | + [`common.hijackStdOut()`]: #hijackstdoutlistener | ||
| 459 | 463 | [internationalization]: https://github.com/nodejs/node/wiki/Intl | |
0 commit comments