Project Name

@jevesh/ratelimiter is a Node.js package designed to provide rate-limiting functionality for your applications. This package helps you control the rate at which requests are processed, protecting your services from being overwhelmed by too many requests.

Prerequisites

This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
6.4.1
v8.16.0

Table of contents

• Project Name
  • Prerequisites
  • Table of contents
  • Getting Started
  • Installation
  • API
    • useBasicFetch
      • Options
    • fetchData
  • Contributing
  • License

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

BEFORE YOU INSTALL: please read the prerequisites

Start with cloning this repo on your local machine:

$ git clone https://github.com/jevesh-code/rate-limiter.git
$ cd rate-limiter

To install and set up the library, run:

$ npm i @jevesh/ratelimiter

Or if you prefer using Yarn:

$ yarn add --dev myLib

API

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Run lint check: npm run lint
4. (Optional) Fix lint error (manually or use npm run lint:fix )
5. Add your changes: git add .
6. Commit your changes: git commit -am 'Add some feature'
7. Push to the branch: git push origin my-new-feature
8. Submit a pull request :sunglasses:

License

MIT License © Andrea SonnY