ap1
v0.2.5
Published
all-in-one frontend server
Downloads
18
Readme
ap1
Ap1 is an all-in-one set of frontend server, a kitchen sink switchboard of servers for receiving requests and issuing responses.
An instance includes an Express HTTP server, Socket.io websocket server, standard socket server, and incoming/outgoing email server, with modularity for adding other server types and protocols.
Incoming requests are received on a server, and normalized into an options object, including the following:
{
'$session': {} //object including stateful information about the session associated with the request/response
, '$request': {} //object including request data / socket
, '$response': {} //object for responding to request / socket
, '$server': {} //server that originated the request
, '$data': {} //all data from the transaction
, '$url': {} //parsed information on the url of the request
}
Plugins can include a variety of go-to methods for performing different types of message transactions (i.e. email confirmations, payments, location lookups, file uploads).
Getting Started
Install the module with: npm install ap1
var API = require('ap1');
License
Copyright (c) 2015 Ben Sack Licensed under the MIT license.