Socket
Socket
Sign inDemoInstall

weathercompanyapi-node

Package Overview
Dependencies
49
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    weathercompanyapi-node

Node Client to access The Weather Company API


Version published
Weekly downloads
7
increased by75%
Maintainers
1
Install size
9.20 MB
Created
Weekly downloads
 

Readme

Source

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.

Keywords

FAQs

Last updated on 01 Feb 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc