@code-pushup/portal-client
TypeScript icon, indicating that this package has built-in type declarations

0.6.1 • Public • Published

Code PushUp portal client

Type definitions and client for uploading report to portal.

Setup

npm install @code-pushup/portal-client

Usage

Upload report to portal

import { uploadToPortal } from '@code-pushup/portal-client';

// ...

const report = await uploadToPortal({
  server: '<GRAPHQL URL>',
  apiKey: process.env.CODE_PUSHUP_API_KEY,
  data: {
    organization: '<ORGANIZATION SLUG>',
    project: '<PROJECT SLUG>',
    commit: '<COMMIT SHA>',
    plugins: [
      // ...
    ],
    categories: [
      // ...
    ],
    // ...
  },
});

Readme

Keywords

none

Package Sidebar

Install

npm i @code-pushup/portal-client

Weekly Downloads

244

Version

0.6.1

License

none

Unpacked Size

50.6 kB

Total Files

8

Last publish

Collaborators

  • tlacenka
  • bio_photon
  • matejchalk
  • vmasek