Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soplakanets/node-forecastio
A node.js client for Forecast.io API
https://github.com/soplakanets/node-forecastio
darksky darksky-api forecast forecast-api forecastio node nodejs weather weather-api weather-forecast
Last synced: 11 days ago
JSON representation
A node.js client for Forecast.io API
- Host: GitHub
- URL: https://github.com/soplakanets/node-forecastio
- Owner: soplakanets
- License: mit
- Created: 2014-08-04T11:52:58.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-06-12T11:50:25.000Z (over 6 years ago)
- Last Synced: 2024-12-07T20:12:01.573Z (15 days ago)
- Topics: darksky, darksky-api, forecast, forecast-api, forecastio, node, nodejs, weather, weather-api, weather-forecast
- Language: JavaScript
- Size: 19.5 KB
- Stars: 32
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
forecastio
==========
[](https://travis-ci.org/soplakanets/node-forecastio) [](https://david-dm.org/soplakanets/node-forecastio)
A node.js client library for [Forecast.io API](https://developer.forecast.io).
For explanation and more detailed info about endpoints and response format see [Forecast.IO API documentation](https://developer.forecast.io/docs/v2)
## Installation
```
npm install forecastio
```
## Usage
Say you need a [forecast](https://developer.forecast.io/docs/v2#forecast_call) for London, UK:
```javascript
var ForecastIo = require('forecastio');
var forecastIo = new ForecastIo('');
forecastIo.forecast('51.506', '-0.127').then(function(data) {
console.log(JSON.stringify(data, null, 2));
});
```
### "Time Machine" Requests
Forecast.io also supports [Time Machine requests](https://developer.forecast.io/docs/v2#time_call). Quoting official documentation you can make request for "60 years in the past to 10 years in the future" for "many places". Example:
```javascript
// What was the weather like in London on January 1st 2008?
forecastIo.timeMachine('51.506', '-0.127', '2008-01-01T00:00:01Z').then(function(data) {
console.log(JSON.stringify(data, null, 2));
});
```
### API Options
Both `#forecast()` and `#timeMachine()` methods support passing additional options.
*Below are some examples, for all options consult [Options section of Forecast.IO API documentation](https://developer.forecast.io/docs/v2#options).*
Example of requesting ad forecast in Si(metric) units with only 'daily' fields:
```javascript
var options = {
units: 'si',
exclude: 'currently,hourly,flags'
};
forecastIo.forecast('49.844', '24.028', options).then(function(data) {
console.log(JSON.stringify(data, null, 2));
});
```
Another example, a "Time Machine" request in UK units and localized in Italian:
```javascript
var options = {
units: 'uk',
lang: 'it'
};
forecastIo.timeMachine('49.844', '24.028', '2008-01-01T00:00:01Z', options).then(function(data) {
console.log(JSON.stringify(data, null, 2));
});
```
### Request Timeout
To set timeout for requests pass a timeout option to constructor, example:
```javascript
var forecastIo = new ForecastIo('', {timeout: 30*1000});
```
As a result all API request made with with this `forecastIo` instance will have a timeout of 30 seconds.
Timeout option accepts time in milliseconds. If request will not finish in time - a callback will be fired with a timeout error.
## TODO
- Logging (for debugging at least)
- Smarter API methods (accept `Date` object in `#timeMachine()` and convert it to string, for example)
## Contributing
* Fork the repo & commit changes
* Make sure tests are not failing:
$ env FORECASTIO_API_KEY=`your_api_key` npm test
* Create a pull request
## Changelog
#### 2.0.0
- Dropped support for node < 4.x
- Fixed deprecation warnings for dependencies.
#### 1.0.2
- Fixed deprecation warnings.
#### 1.0.0
- Promises (For compatibility callbacks are still supported).
#### 0.2.0
- Added `timeout` option
#### 0.1.2
- More informative error messages.