https://github.com/johnnythetank/angular-openweathermap-api-factory
AngularJS Factory for OpenWeatherMap JSON REST API requests
https://github.com/johnnythetank/angular-openweathermap-api-factory
angular angular-factory angularjs api factory openweathermap openweathermap-api weather
Last synced: about 1 month ago
JSON representation
AngularJS Factory for OpenWeatherMap JSON REST API requests
- Host: GitHub
- URL: https://github.com/johnnythetank/angular-openweathermap-api-factory
- Owner: JohnnyTheTank
- License: mit
- Created: 2015-12-12T13:01:20.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-09-25T20:27:15.000Z (over 9 years ago)
- Last Synced: 2024-11-08T20:17:53.652Z (over 1 year ago)
- Topics: angular, angular-factory, angularjs, api, factory, openweathermap, openweathermap-api, weather
- Language: JavaScript
- Size: 16.6 KB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**angular-openweathermap-api-factory** is an angularjs module with a [OpenWeatherMap](http://openweathermap.org/) API promise factory.
[](https://badge.fury.io/js/angular-openweathermap-api-factory)
[](https://badge.fury.io/bo/angular-openweathermap-api-factory)
Author: Jonathan Hornung ([JohnnyTheTank](https://github.com/JohnnyTheTank))
## Usage
1. Install via either [bower](http://bower.io/), [npm](https://www.npmjs.com/) or downloaded files:
1. `bower install --save angular-openweathermap-api-factory`
2. `npm install --save angular-openweathermap-api-factory`
3. download [angular-openweathermap-api-factory.zip](https://github.com/JohnnyTheTank/angular-openweathermap-api-factory/zipball/master)
2. Include dependencies in your HTML.
1. When using bower:
```html
```
2. When using npm:
```html
```
3. when using downloaded files
```html
```
3. Add **`jtt_openweathermap`** to your application's module dependencies.
4. Use the factory `openweathermapFactory`
## factory methods
### current weather
#### current weather from city by name
```js
// docs: http://openweathermap.org/current#name
openweathermapFactory.getWeatherFromCitySearchByName({
q:",", //city name and country code divided by comma, use ISO 3166 country codes eg "London,uk"
lang:"", // (optional) http://openweathermap.org/current#multi
units:"", // (optinal) http://openweathermap.org/current#data
type:"", // (optional) 'like' = close result, 'accurate' = accurate result
appid:""
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
#### current weather from city by id
```js
// docs: http://openweathermap.org/current#cityid
openweathermapFactory.getWeatherFromCityById({
id:"", //List of city ID can be downloaded here http://bulk.openweathermap.org/sample/city.list.json.gz
lang:"", // (optional) http://openweathermap.org/current#multi
units:"", // (optinal) http://openweathermap.org/current#data
appid:""
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
#### current weather from group of cities by id
```js
// docs: http://openweathermap.org/current#severalid
openweathermapFactory.getWeatherFromGroupOfCitiesById({
id:",,,...", //List of city ID can be downloaded here http://bulk.openweathermap.org/sample/city.list.json.gz
lang:"", // (optional) http://openweathermap.org/current#multi
units:"", // (optinal) http://openweathermap.org/current#data
appid:""
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
#### current weather from location by coordinates
```js
// docs: http://openweathermap.org/current#geo
openweathermapFactory.getWeatherFromLocationByCoordinates({
lat:"",
lon:"",
lang:"", // (optional) http://openweathermap.org/current#multi
units:"", // (optinal) http://openweathermap.org/current#data
appid:""
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
#### current weather from location by zipcode
```js
// docs: http://openweathermap.org/current#zip
openweathermapFactory.getWeatherFromLocationByCoordinates({
zip:",", //use ISO 3166 country codes
lang:"", // http://openweathermap.org/current#multi
units:"", // (optinal) http://openweathermap.org/current#data
appid:""
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
### 5-day-forecast
#### 5-day-forecast from city by name
```js
// docs: http://openweathermap.org/forecast5#name5
openweathermapFactory.cityForecast5SearchByName({
q:",", //city name and country code divided by comma, use ISO 3166 country codes eg "London,uk"
lang:"", // (optional) http://openweathermap.org/current#multi
units:"", // (optinal) http://openweathermap.org/current#data
type:"", // (optional) 'like' = close result, 'accurate' = accurate result
appid:""
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
#### 5-day-forecast from city by id
```js
// docs: http://openweathermap.org/forecast5#cityid5
openweathermapFactory.getForecast5FromCityById({
id:"", //List of city ID can be downloaded here http://bulk.openweathermap.org/sample/city.list.json.gz
lang:"", // (optional) http://openweathermap.org/current#multi
units:"", // (optinal) http://openweathermap.org/current#data
appid:""
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
#### 5-day-forecast from location by coordinates
```js
// docs: http://openweathermap.org/forecast5#geo5
openweathermapFactory.getForecast5FromLocationByCoordinates({
lat:"",
lon:"",
lang:"", // (optional) http://openweathermap.org/current#multi
units:"", // (optinal) http://openweathermap.org/current#data
appid:""
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
## OpenWeatherMap JSON API
* docs: http://openweathermap.org/api
## More angular-api-factories
[bandsintown](https://github.com/JohnnyTheTank/angular-bandsintown-api-factory) - [dailymotion](https://github.com/JohnnyTheTank/angular-dailymotion-api-factory) - [facebook](https://github.com/JohnnyTheTank/angular-facebook-api-factory) - [flickr](https://github.com/JohnnyTheTank/angular-flickr-api-factory) - [footballdata](https://github.com/JohnnyTheTank/angular-footballdata-api-factory) - [github](https://github.com/JohnnyTheTank/angular-github-api-factory) - **openweathermap** - [tumblr](https://github.com/JohnnyTheTank/angular-tumblr-api-factory) - [vimeo](https://github.com/JohnnyTheTank/angular-vimeo-api-factory) - [wikipedia](https://github.com/JohnnyTheTank/angular-wikipedia-api-factory) - [youtube](https://github.com/JohnnyTheTank/angular-youtube-api-factory)
## License
MIT