README.md
 1  # exit [![Build Status](https://secure.travis-ci.org/cowboy/node-exit.png?branch=master)](http://travis-ci.org/cowboy/node-exit)
 2  
 3  A replacement for process.exit that ensures stdio are fully drained before exiting.
 4  
 5  To make a long story short, if `process.exit` is called on Windows, script output is often truncated when pipe-redirecting `stdout` or `stderr`. This module attempts to work around this issue by waiting until those streams have been completely drained before actually calling `process.exit`.
 6  
 7  See [Node.js issue #3584](https://github.com/joyent/node/issues/3584) for further reference.
 8  
 9  Tested in OS X 10.8, Windows 7 on Node.js 0.8.25 and 0.10.18.
10  
11  Based on some code by [@vladikoff](https://github.com/vladikoff).
12  
13  ## Getting Started
14  Install the module with: `npm install exit`
15  
16  ```javascript
17  var exit = require('exit');
18  
19  // These lines should appear in the output, EVEN ON WINDOWS.
20  console.log("omg");
21  console.error("yay");
22  
23  // process.exit(5);
24  exit(5);
25  
26  // These lines shouldn't appear in the output.
27  console.log("wtf");
28  console.error("bro");
29  ```
30  
31  ## Don't believe me? Try it for yourself.
32  
33  In Windows, clone the repo and cd to the `test\fixtures` directory. The only difference between [log.js](test/fixtures/log.js) and [log-broken.js](test/fixtures/log-broken.js) is that the former uses `exit` while the latter calls `process.exit` directly.
34  
35  This test was done using cmd.exe, but you can see the same results using `| grep "std"` in either PowerShell or git-bash.
36  
37  ```
38  C:\node-exit\test\fixtures>node log.js 0 10 stdout stderr 2>&1 | find "std"
39  stdout 0
40  stderr 0
41  stdout 1
42  stderr 1
43  stdout 2
44  stderr 2
45  stdout 3
46  stderr 3
47  stdout 4
48  stderr 4
49  stdout 5
50  stderr 5
51  stdout 6
52  stderr 6
53  stdout 7
54  stderr 7
55  stdout 8
56  stderr 8
57  stdout 9
58  stderr 9
59  
60  C:\node-exit\test\fixtures>node log-broken.js 0 10 stdout stderr 2>&1 | find "std"
61  
62  C:\node-exit\test\fixtures>
63  ```
64  
65  ## Contributing
66  In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
67  
68  ## Release History
69  2013-11-26 - v0.1.2 - Fixed a bug with hanging processes.  
70  2013-09-26 - v0.1.1 - Fixed some bugs. It seems to actually work now!  
71  2013-09-20 - v0.1.0 - Initial release.
72  
73  ## License
74  Copyright (c) 2013 "Cowboy" Ben Alman  
75  Licensed under the MIT license.