Development API

npm package Node.js version

skuba includes a Node.js API can be used in build and test code. It includes helpers for interacting with our CI & VCS systems.

The skuba package should be a devDependency that is excluded from your production bundle. If your project uses the development API in an internal script at build time, you can use its convenient re-exports:

{
  "devDependencies": {
    "skuba": "*"
  }
}

import { GitHub } from 'skuba';

await GitHub.putIssueComment(/* ... */);

If your project uses the development API in code that is executed at runtime or included in an npm package, install the standalone @skuba-lib/api package as a dependency. This is good hygiene to avoid a runtime dependency on the larger skuba toolkit.

{
  "dependencies": {
    "@skuba-lib/api": "*"
  },
  "devDependencies": {
    "skuba": "*"
  }
}

import * as GitHub from '@skuba-lib/api/github';

await GitHub.putIssueComment(/* ... */);

Table of contents