New Pretend Meaning

    alamid-api

    0.3.4 • Public • Published

    Abstracting different transports (http/websockets) and libraries to a unite them all.

    browser support Build Status Dependency Status

    Usage

    var api = require("alamid-api"),
     
    var router = api.router();
     
    //attach your universal routes
    router.get("/hello", function(req, res, next) {
        res.end("You can use me via ws and http!");
    });
     
    var app = express(),
        server = http.createServer(app),
        io = socketIO.listen(server);
     
    //with connect/express app
    alamidRequest.use(require("alamid-api/plugins/connect"), { app: app });
     
    //with http.Server
    alamidRequest.use(require("alamid-api/plugins/http"), { server: server });
     
    //with socket.io
    alamidRequest.use(require("alamid-api/plugins/socket.io"), { io: io });

    Plugins

    Enhanced Response

     
    api.use(require("alamid-api/plugins/enhancedResponse"));
     

    API

    • res.send(statusCode?, response)
    • res.success(data)
    • res.fail(code)
    • res.error(code)

    Browser Integration Tests

    Use testling to run the integration test in your favourite browser.

    Examples

    • Google Chrome on OSX ./node_modules/.bin/testling -x /usr/bin/open -a "/Applications/Google Chrome.app"
    • Default browser on OSX./node_modules/.bin/testling -u

    Install

    npm i alamid-api

    DownloadsWeekly Downloads

    6

    Version

    0.3.4

    License

    MIT

    Last publish

    Collaborators

    • hpohlmeyer
    • thois
    • jhnns
    • meaku
    • peeri
    • matthaias
    • leomelzer
    • antosan
    • moritzjacobs