1.0.0 • Published 7 years ago

poke-api-tdd v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

PokeApi

Build Status

Coverage Status

A wrapper to work with the PokeApi v2

Browser Support

This library relies on Fetch API. And this API is supported in the following browsers.

ChromeFirefoxOperaSafariIE
39+ ✔42+ ✔29+ ✔10.1+ ✔Nope ✘

Dependencies

This library depends on fetch to make requests to the Poke Web API. For environments that don't support fetch, you'll need to provide a polyfill to browser or polyfill to Node.

Installation

$ npm install poke-wrapper --save

How to use

ES6

// to import a specific method
import { method } from 'poke-wrapper';

// to import everything
import * as pokeWrapper from 'poke-wrapper';

CommonJS

var pokeWrapper = require('poke-wrapper');

UMD in Browser

<!-- to import non-minified version -->
<script src="poke-wrapper.umd.js"></script>

<!-- to import minified version -->
<script src="poke-wrapper.umd.min.js"></script>

After that the library will be available to the Global as pokeWrapper. Follow an example:

const albums = pokeWrapper.getPokemomn('machamp');

Methods

Follow the methods that the library provides.

View the oficial doc PokeApi

Contributing

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

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Ivan Codasquieves
Ivan Codasquieves

License

This project is licensed under the MIT License - see the LICENSE.md file for details

1.0.0

7 years ago