npm.io
0.1.8 • Published 8 years ago

@eyedea-sockets/openweathermap

Licence
MIT
Version
0.1.8
Deps
3
Size
803 kB
Vulns
24
Weekly
0

Syncano Socket for OpenWeatherMap

Syncano Socket CircleCI branch Codecov branch JavaScript Style Guide npm license

Main Socket features:

  • openweathermap/get-temperature — current temperature for the city
  • openweathermap/get-three-hours — 3 hours forecast for the city

Getting Started

Install package in your project:

cd my_project
npm install @syncano/cli --save-dev
npm install @eyedea-sockets/openweathermap --save
npx s deploy

Use it:

import Syncano from @syncano/core

const s = new Syncano(<instaneName>)

// Temperature for the given city
const cityTemp = await s.get('openweathermap/get-temperature', {city: 'Oslo'})

// Three hours forecast for given city
const forecast = await s.get('openweathermap/get-three-hours', {city: 'Oslo'})

Endpoints

openweathermap/get-temperature
Input:
Parameter Type Required Example
city string Yes Oslo
Outputs:

success - Operation Successful

  • Code: 200
  • Mimetype: application/json
Parameter Type Description Example
temp float Current City Temp -12.2

fail - Operation failed

  • Code: 400
  • Mimetype: application/json
Parameter Type Description Example
message string Error message Internal error.
openweathermap/get-three-hours
Input:
Parameter Type Required Example
city string Yes Oslo
Outputs:

success - Operation Successful

  • Code: 200
  • Mimetype: application/json
Type Description Example
array Three hours forecast [{"forecast": "Clouds", "hour": "5 PM"}, {"forecast": "Clear", "hour": "8 PM"}, {"forecast": "Clear", "hour": "11 PM"}]

fail - Operation failed

  • Code: 400
  • Mimetype: application/json
Parameter Type Description Example
message string Error message Internal error.

Keywords