1.0.0 • Published 8 years ago

require-first v1.0.0

Weekly downloads
4
License
ISC
Repository
github
Last release
8 years ago

Require the first module that matches in a set of directories

NPM Version NPM Downloads Build Status js-happiness-style

A utility library to help finding and requiring modules. Given a set of paths to look in, the module will find the first requireable match and require it.

Usage

$ npm install --save require-first
var requireFirst = new require('require-first');

var dir = 'path/to/root'

var f1 = requireFirst.require([
	dir + '/dir1',
	dir + '/dir2'
], 'file1');

// f1 will be the exported value of the file 'path/to/root/dir1/file1.js' if it exists,
// othwrwise it will be the the value exported by 'path/to/root/dir1/file1.js'

You can also require all the modules found in a set of directories but only the first of each filename will be loaded.

var requireFirst = new require('require-first');

var dir = 'path/to/root'

var f = requireFirst.requireAll([
	dir + '/dir1',
	dir + '/dir2'
]);

// f will be an objecy with a key for each file found in both dir1 and dir2
// The first name match for each file will be the only one required