pokemon-names-and-types
Version:
An API for pokemon names and types
49 lines (48 loc) • 2.53 kB
Markdown
# pokemon-names-and-types
[](https://travis-ci.org/SahajR/pokemon-names-and-types)
[](https://codecov.io/gh/SahajR/pokemon-names-and-types)
[](http://npm-stat.com/charts.html?package=pokemon-names-and-types&from=2016-10-06)
[](https://github.com/semantic-release/semantic-release)
[](http://npm.im/pokemon-names-and-types)
[](https://www.codacy.com/app/SahajR/pokemon-names-and-types?utm_source=github.com&utm_medium=referral&utm_content=SahajR/pokemon-names-and-types&utm_campaign=Badge_Grade)
[](http://opensource.org/licenses/MIT)
--
An open source project created as practice for the egghead.io course - https://egghead.io/courses/how-to-write-an-open-source-javascript-library
## Pokemon Names ##
**Get a all Pokemon names**
```javascript
import {pkmn} from 'pokemon-names-and-types'
pkmn.all //Returns all pokemon names as a json array
```
**Get a random Pokemon name**
```javascript
import {pkmn} from 'pokemon-names-and-types'
pkmn.random() //Returns a random pokemon
```
**Get *n* Pokemon names**
```javascript
import {pkmn} from 'pokemon-names-and-types'
pkmn.random(n) //Returns n random pokemon
```
----------
## Pokemon Types ##
**Get type to which another is weak to**
```javascript
import {pkmnTypes} from 'pokemon-names-and-types'
pkmnTypes.getSuperEffectiveType("Steel") //Ice
```
**Check if a type is strong/weak against another**
```javascript
import {pkmnTypes} from 'pokemon-names-and-types'
pkmnTypes.isWeak("Normal","Rock") //True
pkmnTypes.isStrong("Water","Ghost") //False
```
---
## React Pokemon Badge component ##
**Get a badge with name and specified types**
```javascript
import {Badge} from 'pokemon-names-and-types'
//Returns a badge with types indicated by color:
<Badge name="SomePokemon" type1="Fire" type2="Grass"/>
```