node-spc-storm-reports

KO | EN

gitlite — search

#hacktoberfest #react #typescript #go #golang #linux #nodejs #macos #awesome #cli #kubernetes #awesome-list #mcp #openai

node-spc-storm-reports

(★ 8)

A library which extracts Storm Prediction Center storm reports into a usable format

node-spc-storm-reports Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# node-spc-storm-reports

[![npm version](https://badge.fury.io/js/node-spc-storm-reports.svg)](https://www.npmjs.com/package/node-spc-storm-reports)

> This is a library that parses and returns NWS Storm Prediction Center [storm reports](http://www.spc.noaa.gov/climo/online/).

## Install

```
$ npm install node-spc-storm-reports
```

## Usage

```js
var nodeStormReports = require('node-spc-storm-reports');

// Only request tornado reports
nodeStormReports('2016-01-01', { hail: false, windDamage: false }).then(function spcResponse(data) {
  console.log(data);
}).catch(function errorHandler(err) {
  console.log(err);
});
```

## API

### nodeStormReports(date, [options])

### date
- Type: `string`

- String in date format `YYYY-MM-DD`, e.g. 2016-01-30

### options (optional)

- Type: `object`

- Defines which weather products should be returned.  NOTE: If no data is available for a given product, the returned value will be an empty array.

- Properties:
	- `tornado`
		* Type: `boolean`
		* Default: `true`
		* Defines whether tornado reports should be returned
	- `hail`
		* Type: `boolean`
		* Default: `true`
		* Defines whether hail reports should be returned
	- `windDamage`
		* Type: `boolean`
		* Default: `true`
		* Defines whether wind damage reports should be returned
	- `gust`
		* Type: `boolean`
		* Default: `false`
		* Defines whether wind gust reports should be returned
	- `blizzard`
		* Type: `boolean`
		* Default: `false`
		* Defines whether blizzard reports should be returned
	- `freezingRain`
		* Type: `boolean`
		* Default: `false`
		* Defines whether freezing rain reports should be returned
	- `heavySnow`
		* Type: `boolean`
		* Default: `false`
		* Defines whether heavy snow reports should be returned
	- `iceStorm`
		* Type: `boolean`
		* Default: `false`
		* Defines whether ice storm reports should be returned
	- `sleet`
		* Type: `boolean`
		* Default: `false`
		* Defines whether sleet reports should be returned
	- `snow`
		* Type: `boolean`
		* Default: `false`
		* Defines whether snow reports should be returned
	- `wildfire`
		* Type: `boolean`
		* Default: `false`
		* Defines whether wildfire reports should be returned

##Returned Data Structure Sample
```
{
  tornado: [
    {
      id: 1,
      time: '18:30',
      type: 'T',
      distance: 3,
      direction: 'NW',
      city: 'REPUBLIC',
      county: 'MARQUETTE',
      source: 'NWS STORM SURVEY',
      remark: 'PRELIMINARY NWS STORM SURVEY CONFIRMS TREE DAMAGE ASSOCIATED WITH A TORNADO ALONG RIVER ROAD NORTHWEST OF REPUBLIC...INCLUDING SNAPPED WHITE PINES LARGER THAN 12 INCHES IN DIAMETER. TIME ESTIMATED FROM RADAR.',
      office: 'MQT',
      issuance: 1464132240,
      fatalities: 0,
      injuries: 0,
      magnitudeDesignator: null,
      magnitude: null,
      state: 'MI',
      latitude: 46.43,
      longitude: -88.03
    }
  ],
  hail: [
    {
      id: 33,
      time: '19:54',
      type: 'A',
      distance: 3,
      direction: 'W',
      city: 'ARVADA',
      county: 'JEFFERSON',
      source: 'TRAINED SPOTTER',
      remark: null,
      office: 'BOU',
      issuance: 1464139140,
      fatalities: 0,
      injuries: 0,
      magnitudeDesignator: 'M',
      magnitude: 100,
      state: 'CO',
      latitude: 39.82,
      longitude: -105.16
    }
  ],
  windDamage: [
    {
      id: 104,
      time: '19:00',
      type: 'W',
      distance: 3,
      direction: 'WNW',
      city: 'PEEL',
      county: 'MARION',
      source: 'EMERGENCY MNGR',
      remark: 'TREES AND POWERLINES DOWN IN THE AREA.',
      office: 'LZK',
      issuance: 1464118500,
      fatalities: 0,
      injuries: 0,
      magnitudeDesignator: null,
      magnitude: null,
      state: 'AR',
      latitude: 36.45,
      longitude: -92.82
    }
  ]
}
```

## License

[ISC](https://github.com/jcharrell/node-spc-storm-reports/blob/master/LICENSE) © [Chris Harrell](https://github.com/jcharrell)

node-spc-storm-reports

node-spc-storm-reports Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

node-spc-storm-reports

node-spc-storm-reports Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README