@mugan86/openweather-api
TypeScript icon, indicating that this package has built-in type declarations

2.1.4 • Public • Published

Openweather API (in working)

npm version Build Status Coverage Status Documentation

API Openweather with basic request.

Functions

Current Weather data.

  • By city name: Examples = ('Roma,it', 'Barcelona,es', 'Paris,fr', 'Bilbao,es' ,...)
  • By location: Example: {lat: 36.1699412, lng: -115.13982959999998} = Las Vegas
  • By zip code: Example: 89104 - Las Vegas

Forecast Weather data (Next 5 days in 3 hours period)

  • Pending to implement

Installation.

npm install @mugan86/openweather-api

Generate DIST

npm run watch

or

tsc -w

Usage

  • Register in Openweathermap.
  • Take API key from: API Keys
  • Follow this example. Basic example.

Imports

Typescript

import { ApiService } from '@mugan86/openweather-api';

const api = new ApiService('YOUR_API_KEY', 'm', 'es');

Javascript

const lib = require('@mugan86/openweather-api');
const apiService = lib.ApiService;

const api = new apiService('YOUR_API_KEY'); // unit metric = metres / lang = english

How to use

api.getCurrentWeather('city', ['Barcelona,es']).then(
    (data) => {
        console.log('***************** BARCELONA *****************');
        console.log(data)
    },
    (err) => console.error(err) // Show error in console);
);

api.getCurrentWeather('zip', ['89104']).then(
    (data) => { 
        console.log('***************** LAS VEGAS *****************');
        console.log(data)
    },
    (err) => console.error(err) // Show error in console);
);

api.getCurrentWeather('location', [{lat: 36.1699412, lon: -115.13982959999998}]).then(
    (data) => { 
        console.log('***************** LAS VEGAS *****************');
        console.log(data)
    },
    (err) => console.error(err) // Show error in console);
);

Build your project with Webpack

If you want to include this library inside a project builds with webpack for a client application, you must add this configuration inside your webpack configuration:

{
    target: "web",
    node: {
        fs: "empty",
        net: "empty",
        tls: "empty"
    }
}

Build your project with Webpack in Angular

If you want to include this library inside a project builds with webpack for a client application, you must add this configuration inside your webpack configuration. Go to node_modules/@angular-devkit/build-angular/src/angular-cli-files/models/webpack-configs/browser.js Go to file end and replace:

{
    plugins: extraPlugins,
    node: false
}

with

{
    plugins: extraPlugins,
    target: "web",
    node: {
        fs: "empty",
        net: "empty",
        tls: "empty"
    }
}

License

MIT

Readme

Keywords

Package Sidebar

Install

npm i @mugan86/openweather-api

Weekly Downloads

0

Version

2.1.4

License

MIT

Unpacked Size

24.7 kB

Total Files

37

Last publish

Collaborators

  • mugan86