Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    flatten-requiredpublic

    flatten-required

    Flatten required module with list of all core dependencies.

    Uses q promise library.

    Help

    Unfortunately I don't have any more time to maintain this repository :-(

    Don't you want to save me and this project by taking over it?

    sad cat

    Installation

    $ npm install flatten-required

    Usage

    Result is just simple object without any depth (like original required library).

    var required = require('flatten-required');
     
    required('/path/to/my/file.js').then(function(result) {
        // do something with results
    });

    Result object

    • files: list of paths to all required files (recursively)
    • core: object with list of used core modules

    Load all core dependencies

    If you want to get all dependencies (even from all core files recursively) you have to set depth of nesting.

    There we load all used modules recursively (quite slow):

    required('/path/to/module/with/core/module.js', true).then(function(result) {
        // do something
    });

    Another options is to set final depth of nesting:

    required('/path/to/module/with/core/module.js', 2).then(function(result) {
        // do something
    });

    You can also specify list of only allowed core modules. Core modules which are not in this list, will not be searched.

    required('/path/to/module/with/core/module.js', true, ['events', 'utils']).then(function(result) {
        // do something
    });

    Find dependencies for more files

    required.findMany([
        '/first/file.js',
        '/second/file.js'
    ]).then(function(result) {
        // do something
    });

    This will load all dependencies from these two files and merge their results. You can of course use also depth for core modules.

    Tests

    $ npm test

    Changelog

    • 1.1.2

      • Move under Carrooi organization
      • Abandon package
    • 1.1.1

      • Forgot to add option allowed cores to findMany method
    • 1.1.0

      • Optimized tests
      • Added option for only list of allowed cores
    • 1.0.0

      • Initial version

    install

    npm i flatten-required

    Downloadsweekly downloads

    2

    version

    1.1.2

    license

    MIT

    homepage

    github.com

    last publish

    collaborators

    • avatar