0.2.2 • Published 10 years ago

express-sequelize-wrapper v0.2.2

Weekly downloads
34
License
-
Repository
github
Last release
10 years ago

Express-Sequelize Wrapper

An express wrapper using sequelize

Resources

Features

  • An easy way to setup a server

Installation

npm install express-sequelize-wrapper

Simple app

Create a new app with AppWrapper.App module, and add below code to your app.js file

var AppWrapper = require('express-sequelize-wrapper'),
	App = AppWrapper.App,
	app;

app = new App();

Set database

To setup database use .setDatabase() method, it recieves database basic configuration and models.

app.setDatabase(
    // Config
    {
        name : 'tablename',
        username : 'username',
        password : 'password',
        // If there's no settings default dialect (sqlite) will be set, 
        settings : {
            dialect : 'postgres',
            port: 5432
        }
    },
    // Models
    function(sequelize,DataTypes){
        var models = {};
        models.User = sequelize.define('User', {
            name: DataTypes.STRING
        });
        return models;
    }
);

Add route

You can add routes using .addRoute() method, it gets a function that recieves depencencies and returns the route configuration

app.addRoute(function(){
    return {
        path : '/route/path',
        callback : function(request,response){
            response.send('Hello World!');
            response.end();
        }
    };
});

Install sub-app

You can also install other apps

Sub App installer

The installer function have can have path and parent parameters or just parent parameter, all paths inside sub-app are set after path.

// Using path
var subAppInstallerWithPath = function(path,parent){
	// Sub-app
	var subApp = new App(path,parent);
	// Sub-app route
	subApp.addRoute({
		path : '/happy-route',
		callback : function(req,res){
		    res.send('Sub app happy route!');
			res.end();
		}
	});
};

// Without path
var subAppInstallerWithoutPath = function(parent){
	// Sub-app
	var subApp = new App(parent);
	// Sub-app route
	subApp.addRoute({
		path : '/cool-route',
		callback : function(req,res){
		    res.send('Sub app cool route!');
			res.end();
		}
	});
};

Installing sub-apps

To install sub-app use .install() method

// Using path
app.install('/sub-app',subAppInstallerWithPath);
// Without using path
app.install(subAppInstallerWithoutPath);

Start and stop server

To start server use .start() method

app.start();

And stop server using .stop() method

app.stop();
0.2.2

10 years ago

0.2.1

11 years ago

0.2.0

11 years ago

0.1.9

11 years ago

0.1.8

11 years ago

0.1.7

11 years ago

0.1.6

11 years ago

0.1.5

11 years ago

0.1.4

11 years ago

0.1.3

11 years ago

0.1.2

11 years ago