weatheralerts

Weather Alerts Library

A library written in TypeScript for recieving weather alerts from countries around the world.

Currently supported countries

• [x] United Kingdom (Met Office)
• [x] United States (National Weather Service)
• [ ] Canada (Enviroment Canada / Alert Ready)
• [x] New Zealand (MetService)
• [x] Australia (Bureau of Meteorology)
• [x] All European Union member states (MeteoAlarm)*1

*1 - Austria, Belgium, Bulgaria, Croatia, Republic of Cyprus, Czech Republic, Denmark, Estonia, Finland, France, Germany, Greece, Hungary, Ireland, Italy, Latvia, Lithuania, Luxembourg, Malta, Netherlands, Poland, Portugal, Romania, Slovakia, Slovenia, Spain and Sweden.

How to use

NodeJS:

const { MeteoAlarm } = require("weather-alerts"); // Import the MeteoAlarm class

MeteoAlarm.getAlerts("Belgium").then((alerts) => { // Get the alerts for Belgium
  console.log(alerts); // Log the alerts
});

TypeScript:

import { MetOffice } from "weather-alerts"; // Import the MetOffice class

MetOffice.getAlerts("East Midlands").then(alerts => { // Get the alerts for the East Midlands of the UK
    console.log(alerts); // Log the alerts
});

All countries have their own class, which can be imported from the library. The class name is the meteological service name in camel case, with the first letter capitalised. For example, the Met Office is MetOffice, the National Weather Service is NationalWeatherService, and the MeteoAlarm service is MeteoAlarm. All classes are also aliased to their country name and a two letter abreviation of the meteological service name.

Notices

• Most of the time, the meterological offices in the supported countries will require you to link to any active alerts. Please check the terms and conditions of the weather alert service you are using before using this library.
• This library is not affiliated with any of the weather alert services listed above.
• Some of the alerts may not be in English. This is due to the fact that the weather alert services do not provide an English translation of the alert. This library will return the alert in the language it is provided in. However, the following countries do provide an English translation of the alert: United Kingdom, United States, New Zealand, Australia, Ireland.

Change log

1.0.0 & 1.0.1 & 1.0.2 & 1.0.3 - Broken releases, do not use. (I don't know how to use NPM. I also don't know how to delete releases.)