Skip to content

nickolasclarke/openaq

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

openaq

A ES6 promise-based JS client for the OpenAQ API

Install:

npm install openaq
const openaq = require('openaq')
const client = new openaq

API:

Any parameters should be passed as an optional params object as seen in the examples.

  • example:
cities().then(results => {
  //results here
})

//with optional parameters
cities({country:'US', page:2}).then(results => {
  //results here
})
  • example:
countries().then(results => {
  //results here
})

//with optional parameters
countries({limit:10, page:2}).then(results => {
  //results here
})
  • example:
fetches().then(results = {
  //results here
})

//with optional parameters
fetches({limit:10, page:2}).then(results => {
  //results here
})
  • example:
latest().then(results => {
  //results here
})

//with optional parameters
latest({location:'Bowling Green', parameter:'o3'}).then(results => {
  //results here
})
  • example:
locations().then(results => {
  //results here
})

//with optional parameters
locations({location:'Bowling Green', parameter:'o3'}).then(results => {
  //results here
})
  • example:
measurements().then(results => {
  //results here
})

//with optional parameters
measurements({location:'Bowling Green', parameter:'o3'}).then(results => {
  //results here
})
  • example:
parameters().then(results => {
  //results here
})
  • example:
sources().then(results => {
  //results here
})

//with optional parameters
sources({limit:10, page:2}).then(results => {
  //results here
})

TODO

  • add testing
  • make isomorphic (commonJS and ES2015 module support)