Grafana Incident Node API

The Grafana Incident Node client library allows you to access the Grafana Incident API from your Typescript or JavaScript code.

• Get started with the Grafana Incident API documentation
• Or dive deep into the JavaScript reference docs

Installation

npm install @grafana/incident-api
# or
yarn add @grafana/incident-api

Development

Dev Commands

This project uses TSDX. Start dev environment with:

npm start
# or
yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

To do a one-off build, use npm run build or yarn build.

To run tests, use npm test or yarn test.

Configuration

Set up with prettier, husky, and lint-staged. Adjust the respective fields in package.json accordingly.

Jest

Jest tests are set up to run with npm test or yarn test.

Bundle Analysis

size-limit is set up to calculate the real cost of your library with npm run size and visualize the bundle with npm run analyze.

Rollup

We use Rollup as a bundler and generate multiple rollup configs for various module formats and build settings.

Continuous Integration

GitHub Actions

Two actions are active:

• main which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
• size which comments cost comparison of your library on every pull request using size-limit

Publishing to NPM

We recommend using np.