require-file-directory :
An easy way to require all files or specific files within a directory. Useful when need to require group of files in same directory.
Inspired by many similar packages. They are good, but they require all the files of given directory.
Limitations of these packages :
- What if developer want to require specific files from directory?
- What if developer don't want to give full path of the file who has to be require?
- What if developer want to require files by specific extension?
require-file-directory package have solution for these limitation :
- Developer can require files within a directory by their choice.
- Developer can require files with only their names no need of full path.
- Developer can require all the files or specific files in a directory by giving their names only.
- Developer can require files with specific extension in a directory.
Installation :
npm install --save require-file-directory
Usage :
Basic Usage :
var requireFiles = require('require-file-directory'); requireFiles.ScanAll(dirPath, filesToRequire, extension, isAll);
Package contains a function called ScanAll who returns a object in which keys are files names and their values are data of these files.
Params :
- dirPath : Path of the directory from which files to be require.
- filesToRequire : Array type : If isAll is True then it should be an empty array, otherwise it is the array of strings in which strings are the filenames who has to be require.
- extension : String type : It is the extension of files who has to be require.
- isAll : Boolean type : True, if all files of given directory to be require. False, if only selected files to be require.
/* Path : (__dirname) for current directory. For following, developer has to install package 'path' from npm: (path.dirname(require.main.filename)) for root directory. (path.dirname(require.main.filename)+'/path/to/directory') for specific path. */
Example :
For Specific files in a directory :
var requireFiles = require('require-file-directory'); var path = require('path'); var filesToRequire = ["route", "main"]; var extension = '.js'; var isAll = false; requireFiles.ScanAll((path.dirname(require.main.filename)+'/public/routes'), filesToRequire, extension, isAll);
For All files in a directory :
var requireFiles = require('require-file-directory'); var path = require('path'); var filesToRequire = []; var extension = '.js'; var isAll = true; requireFiles.ScanAll((path.dirname(require.main.filename)+'/public/routes'), filesToRequire, extension, isAll);