Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fbosch/poke-types
🔥💧🍃 Pokémon types, including — their weaknesses, strengths and immunities.
https://github.com/fbosch/poke-types
game game-freak module nintendo npm-package package pokemon pokemon-types resource types
Last synced: about 1 month ago
JSON representation
🔥💧🍃 Pokémon types, including — their weaknesses, strengths and immunities.
- Host: GitHub
- URL: https://github.com/fbosch/poke-types
- Owner: fbosch
- License: mit
- Created: 2018-02-16T22:03:48.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T19:04:23.000Z (almost 2 years ago)
- Last Synced: 2024-10-10T19:52:54.538Z (2 months ago)
- Topics: game, game-freak, module, nintendo, npm-package, package, pokemon, pokemon-types, resource, types
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/poke-types
- Size: 802 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-pokemon - PokeTypes - Get Pokémon types, weaknesses and strengths. (Development Projects)
README
# PokéTypes
[](https://github.com/tobiasbueschel/awesome-pokemon)
[](https://travis-ci.org/fbosch/poke-types)
[](https://standardjs.com)
[](https://snyk.io/test/github/fbosch/poke-types?targetFile=package.json)
---
🔥 💧 🍃
A module that exposes all Pokémon types, including
— their weaknesses, strengths and immunities.
## Install
### `yarn`
```sh
$ yarn add poke-types
```
### `npm`
```sh
$ npm install --save poke-types
```
## Usage
```js
import { getTypeWeaknesses } from 'poke-types'
import { noEffect, notVeryEffective, superEffective, ultraEffective } from 'poke-types/effectiveness'
const abilityEffectiveness = (targetType, abilityType) => {
switch (getTypeWeaknesses(...targetType)[abilityType]) {
case noEffect: return 'It has no effect...'
case notVeryEffective: return 'It\'s not very effective...'
case superEffective: case ultraEffective: return 'It\'s super effective!'
default: return ''
}
}
const attack = pokemon => target => ability => {
return `
${pokemon.name} used ${ability.name}!
💥
${abilityEffectiveness(target.type, ability.type)}
`
}
const pikachu = {
name: 'Pikachu',
type: 'electric',
abilities: {
thunderbolt: {
name: 'Thunderbolt',
type: 'electric'
}
},
attack: target => ability => attack(pikachu)(target)(pikachu.abilities[ability])
}
const gyarados = {
name: 'Gyarados',
type: ['water', 'flying']
}
console.log(pikachu.attack(gyarados)('thunderbolt'))
// Pikachu used Thunderbolt!
// 💥
// It's super effective!
```
## API
### .effectiveness: _Object_
| noEffect | weak | notVeryEffective | normal | superEffective | ultra |
|---------- |------ |------------------ |-------- |---------------- |------- |
| 0 | 0.25 | 0.5 | 1 | 2 | 4 |
### .types: _string[]_
| normal | fire | water | electric | grass | ice | fighting | poison | ground |
|--------|----------|-------|----------|-------|--------|----------|--------|--------|
| **flying** | **psychic** | **bug** | **rock** | **ghost** | **dragon** | **dark** | **steel** | **fairy** |
### .getTypeWeaknesses(type: _string_, ?secondType: _string_): Object
#### type
[type](#types-string) name to get weaknesses for
#### secondType
the second [type](#types-string) to get dual [type](#types-string) weaknesses for
```js
pokeTypes.getTypeWeaknesses('grass')
// { normal: 1, fire: 2, water: 0.5, ... }
pokeTypes.getTypeWeaknesses('fire', 'bug')
// { normal: 1, fire: 1, water: 2, ... }
```
### .getTypeStrengths(type: _string_): Object
#### type:
[type](#types-string) name to get type strengths for.
```js
pokeTypes.getTypeStrengths('electric')
// { normal: 1, fire: 1, water: 2, ... }
pokeType.getTypeStrengths('fighting')
// { normal: 2, fire: 1, water: 1, ... }
```
## License
MIT @ [Frederik Bosch](https://github.com/fbosch)