read-all-stdin-sync/README.md

Save one level of indentation in scripts that won't do anything anyway until they've read all of stdin.

<!--#echo json="package.json" key="name" underline="=" -->
read-all-stdin-sync
===================
<!--/#echo -->

<!--#echo json="package.json" key="description" -->
Save one level of indentation in scripts that won&#39;t do anything anyway
until they&#39;ve read all of stdin.
<!--/#echo -->


Caveats
-------

  * Only works if data *can* be read from stdin right away,
    e.g. reading from a ready file handle.
    * If stdin isn't ready, expect
      `Error: EAGAIN: resource temporarily unavailable, read`
    * We can't just wait and retry in sync mode because Node probably won't
      do I/O if we [sleep](https://www.npmjs.com/package/sleep).


```javascript
var data = require('read-all-stdin-sync')();
console.dir(Object.keys(JSON.parse(data)));
```

If you want to get rid of a possible leading Byte-Order Mark:

```javascript
var data = require('read-all-stdin-sync')({ stripBOM: true });
console.dir(Object.keys(JSON.parse(data)));
```

Actually, there's a shorthand for BOM stripping and parsing JSON:

```javascript
var data = require('read-all-stdin-sync')(JSON);
console.dir(Object.keys(data));
```

You can read buffers, too:

```javascript
var data = require('read-all-stdin-sync')({ encoding: null });
console.dir(data);
```

Easier to remember:

```javascript
var data = require('read-all-stdin-sync')(Buffer);
console.dir(data);
```


<!--#toc stop="scan" -->



&nbsp;


License
-------
<!--#echo json="package.json" key=".license" -->
ISC
<!--/#echo -->