# simple-rlm

> A simple ratelimit manager

Latest version **1.0.4** (published 2017-09-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-rlm
pnpm add simple-rlm
yarn add simple-rlm
bun add simple-rlm
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2017-09-12 |
| First published | 2017-09-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Sandi Karajic |
| Maintainers | skarajic |

## Links

- npm: https://www.npmjs.com/package/simple-rlm
- Repository: https://github.com/SKarajic/SimpleRateLimitManager
- Homepage: https://github.com/SKarajic/SimpleRateLimitManager#readme
- Issues: https://github.com/SKarajic/SimpleRateLimitManager/issues
- npm.io page: https://npm.io/package/simple-rlm

## Recent versions

- 1.0.4 (latest) — 2017-09-12
- 1.0.2 — 2017-09-12
- 1.0.0 — 2017-09-12

## README

# SimpleRateLimitManager
### A simple ratelimit manager
[![Greenkeeper badge](https://badges.greenkeeper.io/SKarajic/SimpleRateLimitManager.svg)](https://greenkeeper.io/)
[![Build Status](https://scrutinizer-ci.com/g/SKarajic/SimpleRateLimitManager/badges/build.png?b=master)](https://scrutinizer-ci.com/g/SKarajic/SimpleRateLimitManager/build-status/master)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/SKarajic/SimpleRateLimitManager/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/SKarajic/SimpleRateLimitManager/?branch=master)
[![npm version](https://badge.fury.io/js/simple-rlm.svg)](https://badge.fury.io/js/simple-rlm)
[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)
[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)
[![TypeScript](https://badges.frapsoft.com/typescript/version/typescript-next.svg?v=101)](https://github.com/ellerbrock/typescript-badges/)

[![forthebadge](http://forthebadge.com/images/badges/built-by-neckbeards.svg)](http://forthebadge.com)

# What is it?
it's a deadsimple ratelimit manager. It does what it says. it contains one function called **call** which has a few setup options.

# Get Started
install the wrapper by entering:
`npm install --save simple-rlm`

proceed by importing the wrapper and creating the SimpleRateLimitManager object.
```
import RateManager from 'simple-rlm'


/** Create Wrapper Object */
const rlm = new RateManager(1000, 3600)

rlm.call('wait', (callsLeft, periodLeft, error) => {
    if (err) {
        console.log(err)
    } else {
        //perform the thing you want to do
    }
})
```

For the documentation and example **[click here](https://skarajic.github.io/SimpleRateLimitManager/index.html)**

---
_Source: https://npm.io/package/simple-rlm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
