activerules-read-files/README.md

Read multiple files asynchronously, no errors

# activerules-read-files 

[![NPM version](https://img.shields.io/npm/v/activerules-read-files.svg)](https://www.npmjs.com/package/activerules-read-files)
[![Build Status](https://travis-ci.org/bwinkers/activerules-read-files.svg?branch=master)](https://travis-ci.org/bwinkers/activerules-read-files)
[![Code Climate](https://codeclimate.com/github/bwinkers/activerules-read-files/badges/gpa.svg)](https://codeclimate.com/github/bwinkers/activerules-read-files)
[![Coverage Status](https://img.shields.io/coveralls/bwinkers/activerules-read-files.svg)](https://coveralls.io/github/bwinkers/activerules-read-files)
[![Dependency Status](https://img.shields.io/david/bwinkers/activerules-read-files.svg?label=deps)](https://david-dm.org/bwinkers/activerules-read-files)
[![devDependency Status](https://img.shields.io/david/dev/bwinkers/activerules-read-files.svg?label=devDeps)](https://david-dm.org/bwinkers/activerules-read-files#info=devDependencies)


A [Node](https://nodejs.org/) module to read multiple files asynchronously.
MISSING FILES WILL BE IGNORED without error.


```javascript
const multipleFiles = require('activerules-read-files');

multipleFiles(['one.txt', 'another.txt'], (err, bufs) => {
  if (err) {
    throw err;
  }

  bufs; //=> [<Buffer ... >, <Buffer ... >]
});
```

## Installation

[Use npm.](https://docs.npmjs.com/cli/install)

```
npm install activerules-read-files
```

## API

```javascript
const multipleFiles = require('activerules-read-files');
```

### multipleFiles(*paths* [, *options*], *callback*)

*paths*: `Array` of `String` (file paths)  
*options*: `Object` ([fs.readFile] options) or `String` (encoding)  
*callback*: `Function`

#### callback(*error*, *contents*)

*error*: `Error` if it fails terribly, otherwise `null`, it does not error on a missing file.
*contents*: `Array` of `Buffer` or `String` (according to `encoding` option)

The second argument will be an array of file contents. The order of contents follows the order of file paths. 

It automatically strips [UTF-8 byte order mark](https://en.wikipedia.org/wiki/Byte_order_mark#UTF-8) from results.

```javascript
const multipleFiles = require('activerules-read-files');

// foo.txt: Hello
// bar.txt: World

multipleFiles(['foo.txt', 'bar.txt'], 'utf8', (err, contents) => {
  if (err) {
    throw err;
  }

  contents; //=> ['Hello', 'World']
});
```

If it fails terribly it passes an error to the first argument and doesn't pass any values to the second argument. It will silent handle missing files withiut throwing an error.

```javascript
const multipleFiles = require('activerules-read-files');

// foo.txt: exists
// bar.txt: doesn't exist
// baz.txt: exists

multipleFiles(['foo.txt', 'bar.txt', 'baz.txt'], (err, contents) => {
  err.code; //=> 'ENOENT'
  contents; //=> undefined
  arguments.length; //=> 1
});
```

## Related project

* [activerules-read-files-promise](https://github.com/bwinkers/activerules-read-files-promise) ([Promises/A+](https://promisesaplus.com/) version)

## License

Copyright (c) 2017 - Brian Winkers

Licensed under [the MIT License](./LICENSE). 

[fs.readFile]: https://nodejs.org/api/fs.html#fs_fs_readfile_filename_options_callback

Check back soon...