Giter Club home page Giter Club logo

weather's Introduction

weather

Build Status Dependencies Status Coverage Status GitHub License

Commitizen Friendly code style: prettier Code Style npm version

Helpers to fetch weather information from well know sources

Requirements

Installation

npm install @lykmapipo/weather --save

Usage

import { fetchForecasts } from '@lykmapipo/weather';

const optns = { city: 'Dar Es Salaam' };
fetchForecasts(optns)
  .then(forecasts => { ... }) // => [{ weather: 'Light Rain', ... }, ... ]
  .catch(error => { ... });

Forecast Schema

Name Type Description
issuedAt date Forecast issued date and time
date date Forecast date
weather string Weather description
temperature number Temperature in Celsius
minimumTemperature number Minimum temperature in Celsius
maximumTemperature number Maximum temperature in Celsius
relativeHumidity number Relative humidity
windDirection string Wind direstion
windSpeed number Wind speed in km/h
sunRiseAt date Sun rise time
sunSetAt date Sun set time
moonRiseAt date Moon rise time
moonSetAt date Moon set time
present boolean Flag whether its present forecast

Supported Sources

Testing

  • Clone this repository

  • Install all development dependencies

npm install
  • Run example
npm run examples
  • Then run test
npm test

Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

License

The MIT License (MIT)

Copyright (c) lykmapipo & Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

weather's People

Contributors

lykmapipo avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

weather's Issues

Suggestions - country / weatherIcon

Hi,
I think that it should be at least possible (maybe not required) to specify a country when looking for a city. I'm looking for Roma (Italy) but I get results for Roma (Australia).
Also I think for compatibility it would be better to maintain the wpo api responde structure: https://worldweather.wmo.int/en/json/234_en.json.
Doing so also takes out unuseful repeated data (like city and cityId repeated on each json element) and make available a lot of useful informations (e.g. weatherIcon, stationName, latitude...)

Sorry not being able to make a pull request (not a good programmer).
Thanks you for your attention

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.