Giter Club home page Giter Club logo

directory-modules's Introduction

directory-modules

Use a directory of files as modules for your app

Usage

First install with npm:

$ npm install directory-modules

Then use the sync or async method:

var DM = require('directory-modules');

// Async method
DM.get_modules(__dirname + '/subdir', function (modules) {
  // `modules` is a list of files in subdir/, already require()'d
  // If require fails for some reason, the error is caught
});

// If not callback is provided, a promise is returned
DM
  .get_modules(__dirname + '/subdir')
  .then(function (modules) {
    // Do things with `modules`
  });

// Sync method
var modules = DM.get_modules_sync(__dirname + '/subdir');

Why

If you're writing an app with an API exposed to other developers, you'll expect others to write some sort of modules or extensions for your project. Instead of having some sort of array of installed modules, this package helps you use a subdirectory as that array.

directory-modules goes through the subdirectory you provide and attempts to require() each file or directory it encounters. If an error occurs, directory-modules will let you know in the console, but doesn't throw an error. Once you have the returned list of modules, you can use them as you choose.

directory-modules's People

Contributors

ajay-gandhi avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.