Code Monkey home page Code Monkey logo

nodejs-rate-limiter's Introduction

ip-rate-limiter

An expressJS ip-rate-limit middleware built with TypeScript which inspired by Dcard's internship program.

code style: prettier Weekly Downloads

Requirements

  • 限制每小時來自同一個 IP 的請求數量不得超過 1000
  • 在 response headers 中加入剩餘的請求數量 (X-RateLimit-Remaining) 以及 rate limit 歸零的時間 (X-RateLimit-Reset)
  • 如果超過限制的話就回傳 429 (Too Many Requests)
  • 使用 TypeScript + express + redis 完成

Quick Start

Install

$ npm install ip-rate-limiter

Basic Usage

	import express, { Application, Request, Response, NextFunction } from 'express';
	import rateLimiter from 'ip-rate-limiter';
	import bodyParser from 'body-parser';

	const app: Application = express();

	app.use(bodyParser.json());

	app.get('/', rateLimiter, (req: Request, res: Response) => {
		res.send('test');
	})

	app.listen(5000, () => {
		console.log('server running on port 5000');
	})

Roadmap

  • Flexible arguments
  • Increase Unit Test Coverage
  • Support for other Redis Client

nodejs-rate-limiter's People

Contributors

oldmo860617 avatar

Stargazers

JIN,CHENG-WEI avatar Roman avatar  avatar Sherry avatar janeru avatar firstfu avatar

Watchers

Kyle Mo avatar

Forkers

fossabot

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.