bomjs

A wrapper over the Australian Bureau of Meteorology api

Usage no npm install needed!

<script type="module">
  import bomjs from 'https://cdn.skypack.dev/bomjs';
</script>

README

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.