# pokerare

> Pokemon Rarity Levels

Latest version **0.1.1** (published 2016-09-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install pokerare
pnpm add pokerare
yarn add pokerare
bun add pokerare
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2016-09-06 |
| First published | 2016-09-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Felix Maier |
| Maintainers | maierfelix |
| Keywords | pokemon, pokemongo, pokemon-go, pokemon go, rare, rarity, level |

## Links

- npm: https://www.npmjs.com/package/pokerare
- Repository: https://github.com/maierfelix/pokerare
- Homepage: https://github.com/maierfelix/pokerare#readme
- Issues: https://github.com/maierfelix/pokerare/issues
- npm.io page: https://npm.io/package/pokerare

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 0.1.1 (latest) — 2016-09-06
- 0.1.0 — 2016-09-06

## README

# PokeRare <a href="https://www.npmjs.com/package/pokerare"><img src="https://img.shields.io/npm/v/pokerare.svg?style=flat-square" alt="NPM Version" /></a>

Get rarity levels of Gen I pokemons.

## Install

```
$ npm install --save pokerare
```

## Usage
````js
const rare = require("pokerare");

rare.getRarity(150); // pkmn object with id and rarity level
rare.getPkmnByRarity(255, 255); // array of most common pkmn
````

## API

### .getRarity(id: number) => object

Get rarity of a pokemon by its national dex id.

````js
rare.getRarity(150);
````
#### Result:
````js
{
  id: 150,
  rarity: 3
}
````

### .getPkmnByRarity(from: number, to: number) => array

Get pokemon from rarity range.

````js
rare.getPkmnByRarity(255, 255);
````
#### Result:
````js
[
  { id: 10, rarity: 255 },
  { id: 13, rarity: 255 },
  { id: 16, rarity: 255 },
  ...
]
````

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