mojax-flood-control

mojax-flood-control prevents multiple identical requests from being made over a given period of time.

Getting started

Add mojax and mojax-flood-control to your project: npm install mojax mojax-flood-control --save

Require the two modules into your code, and create your mojax request instance:

var mojax = require("mojax")(),
    floodControl = require("mojax-flood-control");

mojax.use(floodControl());

How mojax uses middleware

Middleware are used to manipulate the request parameters before the actual HTTP request is started.

When you add middleware to a mojax instance, the middleware function gets added to an internal queue. Every time you make a request, the request parameters you have provided are piped through each middleware. Each middleware must return the request parameters object for the next middleware to be called. Not returning the request parameters object (i.e. returning null or undefined) is how you can cancel a request.

The mojax request method respects the following flow:

1. make a request: req(params);
2. your request parameters are piped through each middleware
3. the middleware transform your request parameters
4. the final (transformed) request parameters are used to send the HTTP request
5. the HTTP request triggers callbacks, based on its progress

How mojax-flood-control works

mojax-flood-control is a factory, each instance creates a middleware function that you can use with mojax.

The instance function scans and caches each request made, and verifies if an identical request has been made within the specified delay. If so, it cancels the request, if not it allows the request to go through and register the request into its delay cache.

It is important to note that flood-control will consider a request for the delay period, even if that request is not successful.

---

Modules

mojax-flood-control

Functions

mojax-flood-control(delays) ⇒ function

mojax-flood-control

Summary: prevents duplicate requests from being sent in rapid succession

mojax-flood-control(delays) ⇒ function

Kind: global function
Summary: compiles the parts to create a flood controller function
Returns: function - allowQuery test function, based on past requests
Access: public

Param	Type	Description
delays	object	the delays, in milliseconds, for GET, POST, PUT, DELETE operations