Skip to content
This repository has been archived by the owner on Jan 27, 2021. It is now read-only.

An abstraction layer for the openweathermap.org APIs

License

Notifications You must be signed in to change notification settings

CarbonCollins/openweathermap-nodejs

Repository files navigation

openweathermap-nodejs

GitHub issues GitHub license GitHub release David David Maintainability Test Coverage Known Vulnerabilities

An abstraction layer for the (openweathermap.org) APIs.

Currently only the current weather, 5day forecast, 16day forecast, and UV Index apis have been added

install

npm install openweathermap-apis

usage

To use this package you can either import an individual api or import all of the apis into your application. For an individual module you can use:

import Weather from 'OpenWeatherMap/api';

or

const { Weather } = require('openweathermap-api);

If you want to import all of the modules just use:

const OWM = require('openweathermap-api');

Once imported you need to create a client instance where wou would provide an api key for it to use:

const { Weather } = require('openweathermap-api');

const client = new Weather({
  apiKey: '{yourAPPIDFromopenweathermap.org}'
});

The available APIs are listed in the API Docs Page as all of the static members of the module. If however you have imported all of the apis into a single object then you will have full access to all methods as if you had imported only a single one.

api documentation

The documentation can be found on the API Docs Page

About

An abstraction layer for the openweathermap.org APIs

Resources

License

Stars

Watchers

Forks

Packages

No packages published