dir-to-object
v2.0.0 dir directory files object
dir-to-object
Builds an object from the files contained inside a directory.
Installation
npm install dir-to-object
Usage example
const dirToObject = require('dir-to-object');
const { join } = require('path');
const path = join(__dirname, './__mocks__/foo');
const options = { canAdd: () => true };
const bar = dirToObject(path, options);
console.log(bar);
Where path is a string and it is required:
e.g.:
join(__dirname, './foo')
And where config is an object with the following property:
| name | type | example | required or optional |
|---|---|---|---|
| canAdd | function: (data) => boolean | data => data.resolve && data.type |
optional |
Contributing
- Fork it
- Create your feature branch (
git checkout -b feature/fooBar) - Commit your changes (
git commit -am 'Add some fooBar') - Push to the branch (
git push origin feature/fooBar) - Create a new Pull Request
License
Distributed under the MIT license. See LICENSE for more information.
