JSPM

@cpr/client

0.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q21944F
  • License MIT

REST API client for Cloud Progress

Package Exports

  • @cpr/client

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@cpr/client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

cpr-js

This is the nodejs client for the Cloud Progress rest API. Cloud Progress is a hosted developer tool that provides progress bars with ETA for structured tasks.

The swagger / openapi spec for this api is hosted as a browseable redoc page and in our API repo https://github.com/cloudprogress/cpr-api. The API repo has links to clients in other languages.

Example

Check out pizza.js in this repo 🍕 for a usage example.

Target version of javascript

Intended to be used from node without a buildstep. The .eslintrc.js should be enforcing a recent but not cutting-edge version (async/await + classes but not import).

If you have a reason to need this in the browser and can't make it work, post an issue.

Ops considerations

This throws when there's an API error. Future versions will control that behavior with a flag. Applications that need to be fault-resistant shouldn't use this version in production.

Http client timeouts are also at their defaults. This will be configurable in a future version of the library, but the current version may be subject to hangs when the backend is unavailable.