A limitd plug-in for hapi.js
npm i -S patova
The following code snippet shows how to register the plug-in in your server:
const Hapi = require('hapi');
const patova = require('patova');
const server = new Hapi.Server();
server.connection({ /* options */ });
server.register({
register: patova,
options: {
event: 'onPostAuth',
type: 'users',
address: 'limitd://10.0.0.1:8090',
extractKey: function(request, reply, done){
var key = request.auth.credentials.userId;
done(null, key);
}
},
}, err => {
//
});
The object has the following schema (validated here using Joi):
Required
event: String
- The name of the extension point in the request lifecycle when the bucket check must be performed. Options are"onRequest"
,"onPreAuth"
,"onPostAuth"
,"onPreHandler"
(anything before the request).type: String|(request, callback) => ()
- Either the bucket type as a string or a function. If you use a function, it will be called for every request, this function must invoke the callback function when it is finished.address: String|Object
- Represents the limitd server address. Either a URI with the "limitd" scheme or an object with the following properties:host: String
- The host name / ip address of the limitd server.port: Number
- The port number of the limitd server.
extractKey: (request, done) => ()
- A function that receives therequest
and a callbackdone
.request: Request
- The hapi.js request object.reply: Reply
- The hapi.js reply interface. Useful if you want to skip the check.done: (err: Error, key: String)
- A function that takes an error as the first parameter and the bucket key as the second parameter.
Optional
onError: (error, reply) => ()
- A function that takes theerror
that occurred when trying to get a token from the bucket and thereply
interface.error: Error
- The error that occurred.reply: Reply
- The hapi.js reply interface.
If an error occurs and no function is provided, the request lifecycle continues normally as if there was no token bucket restriction. This is a useful default behavior in case the limitd server goes down.
Feel free to open issues with questions/bugs/features. PRs are also welcome.
MIT