rpc
v3.3.3
Published
Connect/Express middleware that makes handling API calls easier
Downloads
244
Readme
rpc
Setup
npm install rpc
Usage
app = require( "connect" )()
url_path = "/api/" // The url path prefix to watch for and handle
api_path = "/disk/path/to/module" // location of handler module
app.use( require( "rpc" )( url_path api_path ) )
API handler
Your API handler should be a module that can be loaded with require() and should look something like this:
module.exports = function( input, okay, fail ) {
let action = input.action
if( action == "ping" ) {
okay( "pong" );
} else {
fail( "Unrecognized action: " + action );
}
}
The JSON response to the browser will look something like this if you call okay():
{ error: null, data: "pong" }
or this if you call fail():
{ error: "Unrecognized action: foo", data: null }
Options
To let your api handle calls from other domains:
require( "rpc" )( url_path, api_path, { cors: true } );