diff options
| author | Rebecca Turner <me@re-becca.org> | 2018-04-20 18:26:37 -0700 |
|---|---|---|
| committer | Rebecca Turner <me@re-becca.org> | 2018-05-24 23:24:45 -0700 |
| commit | 468ab4519e1b92473acefb22801497a1af6aebae (patch) | |
| tree | bdac1d062cd4b094bde3a21147bab5d82c792ece /deps/npm/node_modules/set-blocking/README.md | |
| parent | ac8226115e2192a7a46ba07789fa5136f74223e1 (diff) | |
| download | node-new-468ab4519e1b92473acefb22801497a1af6aebae.tar.gz | |
deps: upgrade npm to 6.1.0
PR-URL: https://github.com/nodejs/node/pull/20190
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Diffstat (limited to 'deps/npm/node_modules/set-blocking/README.md')
| -rw-r--r-- | deps/npm/node_modules/set-blocking/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/deps/npm/node_modules/set-blocking/README.md b/deps/npm/node_modules/set-blocking/README.md new file mode 100644 index 0000000000..e93b4202b5 --- /dev/null +++ b/deps/npm/node_modules/set-blocking/README.md @@ -0,0 +1,31 @@ +# set-blocking + +[](https://travis-ci.org/yargs/set-blocking) +[](https://www.npmjs.com/package/set-blocking) +[](https://coveralls.io/r/yargs/set-blocking?branch=master) +[](https://github.com/conventional-changelog/standard-version) + +set blocking `stdio` and `stderr` ensuring that terminal output does not truncate. + +```js +const setBlocking = require('set-blocking') +setBlocking(true) +console.log(someLargeStringToOutput) +``` + +## Historical Context/Word of Warning + +This was created as a shim to address the bug discussed in [node #6456](https://github.com/nodejs/node/issues/6456). This bug crops up on +newer versions of Node.js (`0.12+`), truncating terminal output. + +You should be mindful of the side-effects caused by using `set-blocking`: + +* if your module sets blocking to `true`, it will effect other modules + consuming your library. In [yargs](https://github.com/yargs/yargs/blob/master/yargs.js#L653) we only call + `setBlocking(true)` once we already know we are about to call `process.exit(code)`. +* this patch will not apply to subprocesses spawned with `isTTY = true`, this is + the [default `spawn()` behavior](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options). + +## License + +ISC |