1.0.1 • Published 6 years ago

climatempo-wrapper v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
6 years ago

Clima-Tempo Wrapper

Build Status

Coverage Status

A wrapper to work with the Clima-Tempo Web API.

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 Spotify 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 climatempo-wrapper --save

How to use

ES6

// to import a specific method
import ClimaTempoWrapper from 'climatempo-wrapper';
const climaTempo = new ClimaTempoWrapper({
  token: 'YOUR_TOKEN_HERE'
});
// using  method
climaTempo.searchByCityName('Bebedouro');

CommonJS

const ClimaTempoWrapper = require('climatempo-wrapper').default;
const climaTempo = new ClimaTempoWrapper({
  token: 'YOUR_TOKEN_HERE'
});

UMD in Browser

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

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

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

const climaTempo = new ClimaTempoWrapper({
  token: 'YOUR_TOKEN_HERE'
});
const city = climaTempo.searchByCityName('Bebedouro');

Methods

Follow the methods that the library provides.

###search Search for informations about 'search' with provided query. Test in Api Advisor

###searchByCityName Search for informations about 'searchByCityName' with provided query. Test in Api Advisor

###searchByCityID Search for informations about 'searchByCityName' with provided query. Test in Api Advisor

###searchByState Search for informations about 'searchByState' with provided query. Test in Api Advisor

###getWeatherInMoment Search for informations about 'getWeatherInMoment' with provided query. Test in Api Advisor

###getWeatherHistory Search for informations about 'getWeatherHistory' with provided query. Test in Api Advisor

###getSeventyTwoHours Search for informations about 'getSeventyTwoHours' with provided query. Test in Api Advisor

###getFifteenDays Search for informations about 'getSeventyTwoHours' with provided query. Test in Api Advisor

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

Octavio Luiz Benetti Viana

See also the list of contributors who participated in this project.

License

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