Nanoscale Parts Manufacturing
    Have ideas to improve npm?Join in the discussion! »

    express-vhosts-autoloader

    1.0.1 • Public • Published

    NPM Version NPM Downloads Build Status Test Coverage Codacy Badge Dependency Status

    Express VHosts Autoloader

    This module helps you create an Express JS server with virtual hosts auto and manual management.

    Install

    $ npm install express-vhosts-autoloader

    Usage

    This module autoloads your express app's as express middlewares when their folders matches the domain name.

    Your folder names must be the same as your domain names in order for this module to work.

    Let's assume you have this folder structure :

    My Server Folder :

    • server.js
    • node_modules
      • express
      • express-vhosts-autoloader
    • www.nodeapp1.com
      • app.js
    • www.nodeapp2.com
      • app.js
    • www.nodeapp3.com
      • app.js

    And your domain names (pointing to your server) are :

    • www.nodeapp1.com
    • www.nodeapp2.com
    • www.nodeapp3.com
    // Load express.
    var express = require('express');
     
    // Load express vhosts autoloader.
    var vhostsAutoloader = require('express-vhosts-autoloader');
     
    // Create express server.
    var expressServer = express();
     
    // Trigger vhostsAutoloader with expressServer as parameter.
    vhostsAutoloader(expressServer);
     
    // Start your express web server
    var port = process.env['PORT'] || 80;
    var server = expressServer.listen(port, function() {
      console.log( 'Server listening on port %d ', port );
    });

    It works !

    The express vhosts autoloader will load each app.js module in each folder as an express middleware triggered only when the required host (i.e domain name) is provided.

    Each app.js middleware should end with something like module.exports.app = app or exports.app = app

    API

    Promise <= vhostsAutoloader(expressServer, options)

    This function tries to load any app.js file in any folder in the server root folder as an express middleware trigger only when the required domain name is provider in the request.

    • expressServer (object, required) express server instance.

    • options : (object, optional).

      • options.debug (boolean, optional) : defaults to false. If true makes the module more verbose in the console.
      • options.folder (string, optional) : defaults to server root directory. If set vhostsAutoloader tries to load any app.js from the folder provided.
    Example :
    // Tries to load any file in folders located inside /home/user
    vhostsAutoloader(expressServer, {
      folder: '/home/user'
    });

    Promise <= vhostsAutoloader.loadVhost(options)

    This utility method loads an express middleware triggered only when the required host (i.e domain name) is provided.

    • options : (object, required).
      • options.debug (boolean) : defaults to false. If true makes the module more verbose in the console.
      • options.domainName (string, required) : the domain name / folder name
      • options.mainFile (string, optional) : defaults to 'app'. If set the method will try to load the file named after the provided value.
      • options.exportsProperty (string, optional) : defaults to 'app'. If set the method will try to use the exports property named after the provided value
      • options.expressServer (object, optional | required) : Optional if used after calling vhostsAutoloader. Required if vhostsAutoloader.loadVhost is used alone.
      • options.folder (object, optional) : defaults to server root directory. If set vhostsAutoloader.loadVhost tries to load the module from the folder\domainName folder.
    Examples

    Used after calling vhostsAutoloader

    vhostsAutoloader.loadVhost({
      domainName:'www.foo.com'
    });

    For www.foo.com folder .\www.foo.com will be served and app.js module required, needs module.exports.app to be set in app.js.

    vhostsAutoloader.loadVhost({
      domainName:'www.foobar.com',
      mainFile:'index'
    });

    For www.foobar.com folder .\www.foobar.com will be served and index.js module required, needs module.exports.index to be set in index.js.

    vhostsAutoloader.loadVhost({
      domainName:'www.foobarfoo.com',
      mainFile:'index',
      exportsProperty:'bar'
    });

    For www.foobarfoo.com folder .\www.foobarfoo.com will be served, index.js module required, needs module.exports.bar to be set in index.js.

    Used without calling vhostsAutoloader

    // Load express.
    var express = require('express');
    // Load express vhosts autoloader.
    var vhostsAutoloader = require('express-vhosts-autoloader');
    // Create express server.
    var expressServer = express();
     
    vhostsAutoloader.loadVhost({
      domainName:'www.foobarfoo.com',
      mainFile:'foo',
      exportsProperty:'bar',
      expressServer:expressServer
    });

    For www.foobarfoo.com folder .\www.foobarfoo.com will be served, foo.js module required, needs module.exports.bar to be set in foo.js.

    License

    MIT

    Install

    npm i express-vhosts-autoloader

    DownloadsWeekly Downloads

    12

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • avatar