npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cwmsjs

v2.1.5-2024.11.14

Published

CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps

Downloads

733

Readme

CWMSjs

CWMS Data API (CDA) client library created with OpenAPI generator in TypeScript for use with web browsers.

Getting Started

  • Install CWMSjs to your react project with:
    npm install cwmsjs
    (This will grab the latest)

  • Import the API endpoint you wish to use:

    • Avaiable endpoints are here (Classes ending in API): Endpoints
    • At the top of your js/jsx/file type:
      import { TimeSeriesAPI } from "cwmsjs";
    • Then initialize the TimeSeriesAPI with:
      const ts_api = new TimeSeriesAPI();
    • Fetch time series data with:
      await ts_api
        .getTimeSeries({
          office: "SWT",
          name: "KEYS.Elev.Inst.1Hour.0.Ccp-Rev",
        })
        .then((data) => {
          console.log(data);
        })
        .catch((e) => {
          console.log("My Error", e);
        });

Documentation is available for both developers and new users:

Developers

Versioning

In order to accommodate changes both to the generator and to CDA itself, cwmsjs is versioned in the following format: [generator SemVer]-[generation date]

CDA is expected to at some point expose a CalVer for the latest update. When this is available, the generation date will be replaced with the current CDA CalVer.

Publishing

Contributors with authorization can publish a new version of cwmsjs by manually running the "Build, Test, and Publish" GitHub Action.

The workflow will build an updated cwmsjs library using the current generator and national CDA instance OpenAPI spec. If all tests pass, the library will be published to npm and updated documentation will be deployed to GitHub Pages.

Building CWMSjs from source

  • Clone this repository
  • Install dependencies with: npm install
  • Run the generator with: npm run build

All generated files (source, library, and docs) will be in [repo]/cwmsjs