# owm-toolkit

> OpenWeatherMap utility toolkit.

Latest version **0.2.3** (published 2018-10-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install owm-toolkit
pnpm add owm-toolkit
yarn add owm-toolkit
bun add owm-toolkit
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.3 |
| Published | 2018-10-05 |
| First published | 2018-10-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 28 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | pengfluf |
| Maintainers | pengfluf |
| Keywords | openweathermap, openweather, weather, utility, toolkit |

## Links

- npm: https://www.npmjs.com/package/owm-toolkit
- Repository: https://github.com/pengfluf/owm-toolkit
- Homepage: https://github.com/pengfluf/owm-toolkit#readme
- Issues: https://github.com/pengfluf/owm-toolkit/issues
- npm.io page: https://npm.io/package/owm-toolkit

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.2.0

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.2.3 (latest) — 2018-10-05
- 0.2.1 — 2018-10-05

## 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')
```

---
_Source: https://npm.io/package/owm-toolkit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._