Node.js require directory module
Installation
npm install dirreq
Usage
var dirreq = ;var requiredObject = ;
Options
debug: Boolean default false defer: Boolean default true extensions: Array default Object onlyFiles: Boolean default true recursive: Boolean default false requireFunction: Function default require stripExtension: Boolean default true
debug
: if set totrue
, will output debug information to stdout about skipped files and directoriesdefer
: if set totrue
, will call the require function only when accessed viarequiredDirectory.field
extensions
: accepted file extensions. By default,.js
,.json
and.node
are acceptedonlyFiles
: if set totrue
andrecursive
option is not set, will skip directories (i.e. not call the require function on anything that doesn't comply tofs.statSync(path).isFile()
)recursive
: if set totrue
, will also require directories inside the given base directoryrequireFunction
: if set, will call this function instead of the defaultrequire()
stripExtension
: if set totrue
, will remove extension in the field name in the returned object
Example
test
|
+-+ test
|
+- nested.js
+- test1.js
+- test2.js
+- test3.txt
Default
var dirreq = ;var dirs = ; console;/*{ test: { nested: { nested: [Function] } }, test1: [Function], test2: {} }*/
Defer and no recursion
var dirreq = ;var dirs = ; console;/*{ test1: [Getter], test2: [Getter] }*/
Concerns
When loading files recursively (options.recurse
set to true
), the original directory structure will be kept.