node package manager

pikud-haoref-api

pikud-haoref-api

npm version

A Node.js wrapper library for Pikud Haoref's unofficial rocket alert API. It allows you to easily query for the active rocket alert zones in Israel.

Usage

First, install the package using npm:

npm install pikud-haoref-api --save

Then, use the following code to poll for the currently-active rocket alert zones:

var pikudHaoref = require('pikud-haoref-api');
 
// Set polling interval in millis 
var interval = 5000;
 
// Define polling function 
var poll = function () {
    // Get currently active rocket alert zones as an array of zone codes 
    // Example response: ["גולן 1", "חיפה 75", "שפלה 182"] 
    pikudHaoref.getActiveRocketAlertZones(function (err, alertZones) {
        // Schedule polling in X millis 
        setTimeout(poll, interval);
        
        // Log errors 
        if (err) {
            return console.log('Retrieving active rocket alert zones failed: ', err);
        }
            
        // Alert zones header 
        console.log('Currently active rocket alert zones:');
        
        // Log the alert zones (if any) 
        console.log(alertZones);
        
        // Line break for readability 
        console.log();
    });
}
 
// Start polling for active alert zones 
poll();

Requirements

  • Node.js v4.2.x+ for ES6's for-of loop support

License

Apache 2.0