UNPKG

node-clima

Version:

Simple wrapper for OpenWeatherMap API

223 lines (57 loc) 2.52 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Global</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Global</h1> <section> <header> <h2></h2> </header> <article> <div class="container-overview"> <dl class="details"> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="Clima"><span class="type-signature"></span>Clima<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> section: current new Clima(obj) -> Object - obj (Object): Object that contains parameters and their values to sent request. ##### Params on the `obj` object: - format (String): Required, format for the response [json, xml]. - apiKey (String): Required, your api key for the OpenWeatherMap service. - units (String): Optional, the metrics units for the response [Fahrenheit, Celsius, Kelvin] - default: Kelvin. - language (String): Optional, the language for the response. - default en </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="node-clima.js.html">node-clima.js</a>, <a href="node-clima.js.html#line17">line 17</a> </li></ul></dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#Clima">Clima</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Feb 10 2019 20:12:27 GMT+0100 (GMT+01:00) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>