Ezier Ratelimiter

An ezier ratelimiter for nodejs.

Why?

This rate-limiter attempts to keep it e-z, with no additional functions.

All in all a basic package to rate-limit your clients.

Also used in the Fronvo server

Installing

npm i @ezier/ratelimit

Documentation

Documentation for the Ezier Ratelimiter can be found at https://ezier-project.github.io/ratelimit/.

Examples

Setup an instance of EzierLimiter:

1import { EzierLimiter } from '@ezier/ratelimit';
2
3const ezierLimiter = new EzierLimiter({
4    maxPoints: 10,
5    clearDelay: 1000
6});

Consume points for a client:

1ezierLimiter.consumePoints('client-uid', 5);

Handle a consumption error:

1import { EzierLimiterError } from '@ezier/ratelimit';
2
3ezierLimiter.consumePoints('client-uid', 11)
4
5.catch((err: EzierLimiterError) => {
6    // EzierLimiterError check
7    if(err.currentPoints) {
8        console.log(`Client requested ${err.requestedPoints} points when it has ${err.currentPoints} points and maxPoints are ${err.maxPoints}.`);
9    } else {
10        console.log(`[${err.name}]: ${err.message}`);
11    }
12});

Register middleware:

1ezierLimiter.$use({
2    beforeConsumption: ({consumerKey, requestedPoints}) => {
3        console.log(`Attempting to consume ${requestedPoints} points for ${consumerKey}...`)
4    },
5
6    afterConsumption: ({consumerKey, remainingPoints}) => {
7        console.log(`[${consumerKey}]: ${remainingPoints} points remaining.`);
8    }
9});

Stop the rate-limiter:

1ezierLimiter.stop()
2.then(() => {
3    console.log('The Ezier Ratelimiter has been stopped.');
4});

Made by Shadofer with joy.