worldweatheronline-api

2.2.3 • Public • Published

worldweatheronline-api

npm version Build Status Coverage Status Baikal

NPM

un-official client for WorldWeatherOnline's Weather,Local Weather,Time Zone, Marine, Ski and Historical Weather APIs

Installation

Install using npm:

npm install worldweatheronline-api --save

Usage

Require library

var WWO = require('worldweatheronline-api');

Create client

var client = WWO.createClient({
    key: process.env.wwo_key,
    responseType: 'json',
    subscription: 'premium',
    locale: 'EN'
});

Methods

Methods available are:

  1. Search API (searchApi)
  2. Local Weather API (localWeatherApi)
  3. Time Zone API (tizeZoneApi)
  4. Ski Weather API (skiWeatherApi)
  5. Marine Weather API (marineWeatherApi)
  6. Historical Weather API (historicalWeatherApi)

The examples of all APIs are given below

Params

Params as seen at WorldWeatherOnline's API Docs can be passed directly as an object to each of the available functions.

Examples

examples based on usage

Search API

client.searchApi({
    q: "Delhi"
}, function(err, result) {
    if (!err) {
        console.log(result);
    } else {
        console.log(err);
    }
});

Local Weather API

client.localWeatherApi({
    q: "London",
    num_of_days: "3"
}, function(err, result) {
    if (!err) {
        console.log(result);
    } else {
        console.log(err);
    }
});

Time Zone API

client.timeZoneApi({
    q: "208021"
}, function(err, result) {
    if (!err) {
        console.log(result);
    } else {
        console.log(err);
    }
});

Ski Weather API

client.skiWeatherApi({
    q: "London",
    num_of_days: "2"
}, function(err, result) {
    if (!err) {
        console.log(result);
    } else {
        console.log(err);
    }
});

Marine Weather API

client.marineWeatherApi({
    q: "48.834,2.394"
}, function(err, result) {
    if (!err) {
        console.log(result);
    } else {
        console.log(err);
    }
});

Historical Weather API

client.historicalWeatherApi({
    q: "Delhi",
    date: "1995-05-02"
}, function(err, result) {
    if (!err) {
        console.log(result);
    } else {
        console.log(err);
    }
});

Package Sidebar

Install

npm i worldweatheronline-api

Weekly Downloads

2

Version

2.2.3

License

MIT

Last publish

Collaborators

  • rohithzr