casper
Helpers and handlers for building (jsonp) APIs in Express.
All caspers methods return a function that can be used in the Express callback chain, or as callbacks for your database.
example
The following examples assume this:
// express 'app' availablevar casper = ;
Basic handlers
Send an empty opject:
// res.jsonp({}) is sentapp;
Or return some custom data:
// res.jsonp({ hello: 'world' }) is sentapp;
Database callbacks
casper.db
casper.db
returns a function to be used as a database callback. It assumes the first argument is an err
and the second is the data
is has to send – an array or an object.
It takes Express' req
and res
as arguments:
casper
For example:
app;
It can also take a callback which, if present, is called instead of sending data directly back to the client.
With a callback:
app;
If it is passed an error, it will pass that on to the client with a 500 status code. If it recieves no data, or an empty array, it will return the data it recieved with a 404 status.
Checks & filters
capser.check.body
Check for the presence of data in the body using a key:
// body is { testKey: "Hello" }// calls next() becuase presentapp;
If the data is missing from the body it sends a 400 error, detailing the missing parameter:
app; // results inres;
capser.rm.body
Remove a key from the body:
// body is { testKey: "Hello", otherKey: "World" }app; // afterwards body is { otherKey: "World" }
casper.allow.body
Whitelist a key or array of keys allowed on the body.
// body is { testKey: "Hello", otherKey: "World" }app; // afterwards body is { test: "Hello" }
With an array:
// body is { testKey: "Hello", otherKey: "World", unwantedKey: "World" }app; // afterwards body is { testKey: "Hello", otherKey: "World" }
install
npm install casper
license
MIT