Skip to content

Latest commit

 

History

History
58 lines (45 loc) · 1.53 KB

README.md

File metadata and controls

58 lines (45 loc) · 1.53 KB

auto-load

Build Status Dependency Status Coverage Status NPM version

require() all files in subfolder.

This will pre-load all files with require, and build an object.

For instance, given this tree:

├── 1.js
├── 2.js
├── 3
│   ├── 31.js
│   └── 32
│       └── 321.js
└── with-dash.js

Calling autoload(__dirname) will give:

{
  '1': exportsFromFile,
  '2': exportsFromFile,
  'withDash': exportsFromFile,
  '3': {
    '31': exportsFromFile,
    '32': {
      '321': exportsFromFile
    }
  }
}

Where exportsFromFile is the value returned by the file module.exports.

Non js or json files are not loaded.

You can load the files with two types of paths:

  • Absolute, in which case the files will be included from the full path:
autoload(__dirname);
autoload(__dirname + '/directory')
  • Relative, in which case the files will be loaded relative to the root of your project (where the node instance is being executed). To do this, you simply have to pass the name of the file:
// will load /username/projectname/directory
autoload('directory');