@rowanmanning/require-all

Require all modules in a directory recursively.

Table of Contents

• Requirements
• Usage
• Contributing
• License

Requirements

This library requires the following to run:

• Node.js 18+

Usage

Install with npm:

npm install @rowanmanning/require-all

Load the library into your code with a require call:

const requireAll = require('@rowanmanning/require-all');

Require all modules in a directory. Note: this loads modules synchronously, so it's best used only where blocking doesn't matter, e.g. in your application's startup process:

const modules = requireAll('./directory-path');

modules is an array of objects, each being information about the module:

{
    // The name of the file, this is relative to the given directory path
    // and does not include the file extension or a leading slash.
    name: String,

    // The full path to the module.
    fullPath: String,

    // The module file extension, including the leading period, and lower-cased
    extension: String,

    // The required module's exports
    moduleExports: Object
}

Contributing

The contributing guide is available here. All contributors must follow this library's code of conduct.

License

Licensed under the MIT license. Copyright © 2020, Rowan Manning