https://github.com/pengfluf/owm-toolkit

Toolkit to reduce pain using OpenWeatherMap API.
https://github.com/pengfluf/owm-toolkit

Last synced: about 6 hours ago
JSON representation

Toolkit to reduce pain using OpenWeatherMap API.

• Host: GitHub
• URL: https://github.com/pengfluf/owm-toolkit
• Owner: pengfluf
• Created: 2018-10-05T12:32:21.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-05T15:01:40.000Z (about 6 years ago)
• Last Synced: 2024-11-05T10:16:04.427Z (3 days ago)
• Language: JavaScript
• Homepage:
• Size: 82 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# OpenWeatherMap Toolkit

Toolkit to reduce pain using OpenWeatherMap API.

## Why are there so few methods?

It's because of OWM API free plan limitations.

This toolkit is mainly built for beginners doing the common weather application test tasks.

## Usage

All examples related to Saint-Petersburg, Russia. Its ID on OpenWeatherMap is **498817**.

For more details check out [API reference](docs/api-reference.md).

#### Install dependency

```bash

npm install owm-toolkit --save

```

Or you can use [Yarn](https://yarnpkg.com) (which is faster):

```bash

yarn add owm-toolkit

```

#### Initialize OWMToolkit instance

```javascript

import { OWMToolkit } from 'owm-toolkit';

const owm = new OWMToolkit('myApiKey');

```

#### General usage of any method (examples below are without .then() and .catch())

```javascript

owm.SOME_METHOD(498817)

  .then(res => console.log(res))

  .catch(err => console.error(err));

```

#### Get current weather data

```javascript

owm.getCurrent(498817)

```

#### Get 5 day / 3 hour forecast

```javascript

owm.getThreeHours(498817)

```

#### Find city

```javascript

owm.findCity('Saint Petersburg, RU')

```