Skip to content

drdevlin/ec-weather-js

Repository files navigation

ECWeatherJS

The Unofficial, JavaScript Environment Canada Weather API.

Installation

npm install ec-weather-js

Usage

First, fetch weather data for a certain station from Environment Canada's XML weather data, and parse as text.

(This library does not fetch data.)

Next, pass this data into the Weather constructor:

const Weather = require('ec-weather-js');
const weather = new Weather(fetchedXMLWeatherData);

Now you can retrieve all the data as a javascript-friendly object:

weather.all

Or just the current conditions:

weather.current

Or the forecast for a specific date:

weather.forecast(date)

Weekly and Hourly Forecasts

weather.weekly

and

weather.hourly

will return an array of the respective forecasts.

Chain .temperatures, .precipitation, or .winds to further narrow the array.

For example,

weather.hourly.precipitation

returns an array of precipitation forecasts by the hour.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss.

Make sure to update tests as appropriate.

CONTRIBUTING.md

License

MIT