Giter Club home page Giter Club logo

bomjs's Introduction

BomJS

A wrapper over the Australian Bureau of Meteorology api

Node version npm (tag)

Docs • NPM • Github

Install

yarn add bomjs
# or
npm install bomjs

Grab some observations

import { getObservationsWMO, getObservationsBOMID, IObservation, States } from '../dist/app'

// WMO
const data: IObservation = await getObservationsWMO(94768, States.NSW)

// BOM ID
const data: IObservation = await getObservationsBOMID(69017, States.NSW)

Grab forecasts

import { getForecastFromDescription, getForecast, States } from '../build/app'

// From description
const forecast: IForecast = await getForecastFromDescription('canberra', States.NSW)

// From forecast id
const forecast: IForecast = await getForecast('NSW_PW012', States.NSW)

Changelog

  • 1.0.0: Inital release
  • 1.0.1: Include typescript in the npm bundle
  • 1.0.2: Better docs for npm, and increase the build to ES2018

A more detailed change log is available on the github repo.

bomjs's People

Contributors

trickypr avatar

Stargazers

avatar

Watchers

avatar avatar

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.