cimis-node

1.1.2 • Public • Published

Cimis Node

A small Node wrapper for the Cimis API.

Installation

NPM

$ npm install cimis-node

Yarn

$ yarn add cimis-node

Usage

You must have an app key supplied by CIMIS in order to use most parts of the API. Details about registereing with CIMIS can be found here: http://et.water.ca.gov/Home/Register/

import Cimis from 'cimis-node';
 
const cimis = Cimis("my-super-secret-app-key");
 
cimis.stations.all().then(stations => {
  stations[1].fetchData().then(data => console.log(data))
});

API

Cimis

(appKey) -> { stations: Stations }

The main wrapper for the API, allows you to fetch all of the stations. When stations are fetched, will return a list of Station objects.

Stations

{ all: () -> List<Station> }

The canonical way to get a list of all Stations.

Station

{
  detail: Object,
  fetchData: ({ options: Object, hourly: Boolean = true }) -> Object
}

A CIMIS weather station. The detail key contains data about the station itself and the fetchData function fetches data for that station.

StationOptions

{
  startDate: DateString = CurrentDate,
  endDate: DateString = CurrentDate
}

DateString

String<YYYY-MM-DD>

CurrentDate

Today's date, formatted as a DateString

Readme

Keywords

none

Package Sidebar

Install

npm i cimis-node

Weekly Downloads

2

Version

1.1.2

License

MIT

Last publish

Collaborators

  • dphaener