Skip to content

killroyboy/weathercompanyapi-node

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

weathercompanyapi-node

weathercompanyapi-node is a chainable Node client for accessing The Weather Company API

Getting Started

npm install weathercompanyapi-node

Instantiate

const WeatherAPI = require('weathercompanyapi-node');
const apiKey = '12312314';
var weatherApi = new WeatherAPI(apiKey);

Examples

To get location information for atlanta:

weatherApi.search('atlanta', 'city', function (err, data) {
    console.log('atlanta addresses', data);
);

To retrieve current conditions for Sydney, Australia:

weatherApi.location('2020', 'AU').call('observations/current', function (err, data) {
    console.log('conditions', data);
});

You can change settings such as units and language (currently only supports JSON result format).

weatherApi.units('m').language('de-DE').location('2020', 'AU').call('observations/current', function (err, data) {
    console.log('conditions', data);
});

The above example results in metric units and German.

Compatibility

Currently this library is compatible with the Enhanced Current Conditions and Enhanced Forecast APIs.

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

Release History

0.0.1 Initial Release

0.0.2 Fixed a packaging issue

0.0.3 Added hourly forecast

0.0.4 Verify ApiKey and throw error if missing

0.0.5 Allow using a promise on call method

0.0.6 Fixed problem with API Version getting overwritten

0.0.7 Better handling of empty/missing parameters

License

Copyright (c) 2017 Dan Wilson & Skydrop, LLC. Licensed under the MIT license. See LICENSE.

About

Node module to access The Weather Company API

Resources

License

Stars

Watchers

Forks

Packages

No packages published