AccuWeather Wrapper

A simple wrapper to work with the Accuweather Web API. The API provides a lot of methods and options, but I've decided to start just with what I needed to use in my application.

Browser Support

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

| | | | | | | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | | 40+ ✔ | 42+ ✔ | 29+ ✔ | 10.1+ ✔ | Nope ✘ |

Dependencies

This library uses fetch to make requests to the Accuweather 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 accuweather-wrapper --save

How to use

Configuration

Save the .env.sample file as .env and provide the values for the environment variable ACCESS_TOKEN.

ES6

// to import a specific method
import AccuWeatherWrapper from 'accuweather-wrapper'

// passing access token via options
const accuweather = new AccuWeatherWrapper({
  token: 'YOUR_TOKEN_HERE'
})

// using access token via .env file
const accuweather = new AccuWeatherWrapper({})

// using  method getLocation
const lat = 49.2093644
const long = -123.1270038
locationKey = accuweather.getLocation.byGeoposition(lat, long)

CommonJS

const AccuWeatherWrapper = require('accuweather-wrapper').default

// passing access token via options
const accuweather = new AccuWeatherWrapper({
  token: 'YOUR_TOKEN_HERE'
})

// using access token via .env file
const accuweather = new AccuWeatherWrapper({})

UMD in Browser

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

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

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

const accuweather = new AccuWeatherWrapper({
  token: 'YOUR_TOKEN_HERE'
})

const currentConditions = accuweather.getWeather.currentConditions(locationKey)

Methods

Follow the methods that the library provides.

getLocation.byGeoposition(latitude, longitude)

Return the location key for the given coordinates (location key is necessary to get the forecasts). Test in AccuWeather Web Console.

Arguments

| Argument | Type | | ----------- | -------- | | latitude | number | | longitude | number |

Example

accuweather.getLocation.byGeoposition(49.2093644, -123.1270038).then(data => {
  // do what you want with the data
})

getWeather.currentConditions(locationKey)

Return the current conditions for the given location key. Test in AccuWeather Web Console.

Arguments

| Argument | Type | Default | | ------------- | -------- | ------- | | locationKey | number | | | metric | bool | false |

Example

accuweathergetWeather.currentConditions(locationKey).then(data => {
  // do what you want with the data
})

// with metric system
accuweathergetWeather.currentConditions(locationKey, true).then(data => {
  // do what you want with the data
})

getWeather.oneDayForecast(locationKey)

Return daily forecast for the given location key. Test in AccuWeather Web Console.

Arguments

| Argument | Type | Default | | ------------- | -------- | ------- | | locationKey | number | | | metric | bool | false |

Example

accuweathergetWeather.oneDayForecast(locationKey).then(data => {
  // do what you want with the data
})

// with metric system
accuweathergetWeather.oneDayForecast(locationKey, true).then(data => {
  // do what you want with the data
})

getWeather.fiveDaysForecast(locationKey)

Return an array of daily forecasts for the next 5 days for the given location key. Test in AccuWeather Web Console.

Arguments

| Argument | Type | Default | | ------------- | -------- | ------- | | locationKey | number | | | metric | bool | false |

Example

accuweathergetWeather.fiveDaysForecast(locationKey).then(data => {
  // do what you want with the data
})

// with metric system
accuweathergetWeather.oneDayForecast(locationKey, true).then(data => {
  // do what you want with the data
})

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

| | | :-------------------------------------------------------------------------: | | Gustavo Cardoso |

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