Natural Potato Magnet

    wundergrounded

    0.1.4 • Public • Published

    Wundergrounded

    A Node.js module that wraps Weather Underground API's in a flexible, easy-to-use interface. Offers optional request bundling, rate limiting, and caching of responses (all in the name of cutting down on the overall number of HTTP requests).

    Heavily inspired by wundernode and wundergroundnode.


    ## Installation

    npm install wundergrounded --save


    ## Usage

    Initialization

    var Wundergrounded = require('wundergrounded');
    var wundergrounded = new Wundergrounded();

    Interested in caching responses from Weather Underground?

    var Wundergrounded = require('wundergrounded');
    // Configure a new instance with default caching values
    var wundergrounded = new Wundergrounded().cache();

    What about rate limiting the number of requests your app will make to the Weather Underground API?

    var Wundergrounded = require('wundergrounded');
    // Configure a new instance with default limit values
    var wundergrounded = new Wundergrounded().limit();

    But I'd like to do both.

    var Wundergrounded = require('wundergrounded');
    // Configure a new instance with caching and limiting enabled
    var wundergrounded = new Wundergrounded().cache().limit();

    Getting data

    Making a request for a single feature can be done similar to what's below (current conditions for 27705):

    wundergrounded.conditions('27705', function(error, response) {
      if(!error) {
       // do something with the response
      } else {
        // handle the error
      }
    });

    Making a bundled request for multiple features and a specific location can be done by similar to the syntax below (current conditions, hourly forecast, and the 10-day forecast for 27705):

    wundergrounded.conditions().hourly().forecast10day().request('27705', function(error, response) {
      if(!error) {
       // do something with the response
      } else {
        // handle the error
      }
    });

    ## API docs

    Initialization functions

    • apiKey(apiKey) Configures your Wundergrounded client to use the provided API key. By default, Wundergounded will try to read your API key from the WUNDERGROUND_API_KEY environment variable.

      • apiKey - Your Weather Underground API key
    • cache([secondsInCache], [secondsBetweenChecks]) Configures your Wundergrounded client to cache responses that are received from the Weather Underground API.

      • secondsInCache - (optional) Number of seconds to keep responses in the cache. Defaults to 300.
      • secondsBetweenChecks - (optional) Number of seconds between eviction checks. Defaults to 30.
    • limit([numberPer], [timePeriod]) Configures your Wundergrounded client to limit the number of requests it makes to the Weather Underground API. This uses limiter under the hood and accepts similar parameters.

      • numberPer - (optional) Number of requests to make per the specified time period. Defaults to 10.
      • timePeriod - (optional) The time period to use when limiting (i.e. 'second', 'minute', 'hour', 'day'). Defaults to 'minute'.

    Feature functions

    Note: All of Wundergrounded's "feature functions" that retrieve Weather Underground API data are chainable. All chained API calls get bundled together on one request, which reduces overall network traffic (and, consequently, the number of requests you make to Weather Underground.) You can read more about combining requests from Weather Underground's API docs, or see an example of this chainability above in the "Making a bundled request for multiple features" section.

    Note: Only supply the query and callback parameters to these functions if you don't plan on chaining (bundling) requests.

    • alerts([query], [callback]) Refer to Weather Underground's alerts documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • almanac([query], [callback]) Refer to Weather Underground's almanac documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • astronomy([query], [callback]) Refer to Weather Underground's astronomy documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • conditions([query], [callback]) Refer to Weather Underground's conditions documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • currenthurricane([query], [callback]) Refer to Weather Underground's currenthurricane documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • forecast([query], [callback]) Refer to Weather Underground's forecast documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • forecast10day([query], [callback]) Refer to Weather Underground's forecast10day documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • geolookup([query], [callback]) Refer to Weather Underground's geolookup documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • history(date, [query], [callback]) Refer to Weather Underground's history documentation for info on this feature.

      • date - The Date for which to retrieve history information
      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • hourly([query], [callback]) Refer to Weather Underground's hourly documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • hourly10day([query], [callback]) Refer to Weather Underground's hourly10day documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • planner(start, end, [query], [callback]) Refer to Weather Underground's planner documentation for info on this feature.

      • start - The start Date
      • end - The end Date
      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • rawtide([query], [callback]) Refer to Weather Underground's rawtide documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • satellite([query], [callback]) Refer to Weather Underground's satellite documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • tide([query], [callback]) Refer to Weather Underground's tide documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • webcams([query], [callback]) Refer to Weather Underground's webcams documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • yesterday([query], [callback]) Refer to Weather Underground's yesterday documentation for info on this feature.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.
    • request(query, callback) Function for actually "firing" off an HTTP request to the Weather Underground API- used when chaining (bundling) multiple features on one call. An example of it being used can be found in the "Making a bundled request for multiple features" section above.

      • query - (optional) The query to send to the Weather Underground API.
      • callback - (optional) A callback function to invoke once a response is received.

    ## Release history
    • 0.1.4 Fixing race condition in limited requests
    • 0.1.3 Minor updates to README
    • 0.1.0 Initial release

    Install

    npm i wundergrounded

    DownloadsWeekly Downloads

    13

    Version

    0.1.4

    License

    ISC

    Last publish

    Collaborators

    • patrickvalle