Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | - | - | ||||
CHANGELOG.md | D | 12-May-2024 | 718 | 27 | 12 | |
LICENSE.txt | D | 12-May-2024 | 731 | 15 | 12 | |
README.md | D | 12-May-2024 | 1.5 KiB | 32 | 22 | |
index.js | D | 12-May-2024 | 252 | 8 | 7 | |
package.json | D | 12-May-2024 | 1.7 KiB | 72 | 71 |
README.md
1# set-blocking 2 3[![Build Status](https://travis-ci.org/yargs/set-blocking.svg)](https://travis-ci.org/yargs/set-blocking) 4[![NPM version](https://img.shields.io/npm/v/set-blocking.svg)](https://www.npmjs.com/package/set-blocking) 5[![Coverage Status](https://coveralls.io/repos/yargs/set-blocking/badge.svg?branch=)](https://coveralls.io/r/yargs/set-blocking?branch=master) 6[![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version) 7 8set blocking `stdio` and `stderr` ensuring that terminal output does not truncate. 9 10```js 11const setBlocking = require('set-blocking') 12setBlocking(true) 13console.log(someLargeStringToOutput) 14``` 15 16## Historical Context/Word of Warning 17 18This 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 19newer versions of Node.js (`0.12+`), truncating terminal output. 20 21You should be mindful of the side-effects caused by using `set-blocking`: 22 23* if your module sets blocking to `true`, it will effect other modules 24 consuming your library. In [yargs](https://github.com/yargs/yargs/blob/master/yargs.js#L653) we only call 25 `setBlocking(true)` once we already know we are about to call `process.exit(code)`. 26* this patch will not apply to subprocesses spawned with `isTTY = true`, this is 27 the [default `spawn()` behavior](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options). 28 29## License 30 31ISC 32