# @diffblue/cover-client

> Diffblue Cover client library - Node.js API for Diffblue Cover

Latest version **0.5.0** (published 2019-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @diffblue/cover-client
pnpm add @diffblue/cover-client
yarn add @diffblue/cover-client
bun add @diffblue/cover-client
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2019-11-22 |
| First published | 2019-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 8.* \|\| 10.* \|\| 12.* |
| Dependencies | 8 |
| Unpacked size | 94.8 KB |
| Known vulnerabilities | 0 (+33 in 3 direct dependencies) |
| Install scripts | no |
| Author | Diffblue Limited |
| Maintainers | db-ci-platform, peterjwest, peterschrammel, rjmunro, ryanbarwick |

## Links

- npm: https://www.npmjs.com/package/@diffblue/cover-client
- Repository: https://github.com/diffblue/cover-client-js
- Homepage: https://github.com/diffblue/cover-client-js#readme
- Issues: https://github.com/diffblue/cover-client-js/issues
- npm.io page: https://npm.io/package/@diffblue/cover-client

## Dependencies (8)

- [axios](https://npm.io/package/axios.md) 0.19.0
- [lodash](https://npm.io/package/lodash.md) 4.17.15
- [mkdirp](https://npm.io/package/mkdirp.md) 0.5.1
- [bluebird](https://npm.io/package/bluebird.md) 3.7.1
- [url-join](https://npm.io/package/url-join.md) 4.0.1
- [form-data](https://npm.io/package/form-data.md) 2.5.1
- [@types/bluebird](https://npm.io/package/@types/bluebird.md) 3.5.28
- [@diffblue/java-combiner](https://npm.io/package/@diffblue/java-combiner.md) 0.1.8

## Recent versions

- 0.5.0 (latest) — 2019-11-22
- 0.4.3 — 2019-10-02
- 0.4.2 — 2019-09-30
- 0.4.1 — 2019-09-25
- 0.4.0 — 2019-09-23
- 0.3.2 — 2019-07-01
- 0.3.1 — 2019-06-21
- 0.3.0 — 2019-06-19
- 0.2.1 — 2019-06-12
- 0.2.0 — 2019-06-07
- 0.1.1 — 2019-05-31
- 0.1.0 — 2019-05-30
- 0.0.1 — 2019-04-26

## README

# Diffblue Cover client library - Node.js API for Diffblue Cover

The Diffblue Cover client library provides a programmatic interface and CLI for communicating with the Diffblue Cover API.

## Installation

Using npm:

```bash
npm install @diffblue/cover-client
```

## Usage

To use Diffblue Cover to run an analysis and produce test files you will need to provide a JAR file of your compiled code and the path to a directory where you want test files to be written.

In Node.js (using promises):

```js
const Analysis = require('@diffblue/cover-client').Analysis;
const fs = require('fs');

const analysis = new Analysis('https://your-cover-api-domain.com');
const buildFile = fs.createReadStream('./build.jar');
// This is a sample settings object that will not run a useful analysis.
// You can omit the settings parameter when calling `run` to start an analysis with default settings.
const settings = { phases: { firstPhase: { timeout: 10 }}};
const options = { outputTests: './tests' };

analysis.run({ build: buildFile }, settings, options)
.then((results) => {
  console.log(`Analysis ended with the status: ${analysis.status}.`);
  console.log(`Produced ${results.length} tests in total.`);
  console.log(`Test files written to ${options.outputTests}.`);
});
```

In Typescript (using async/await):

```ts
import Analysis from '@diffblue/cover-client';
import { createReadStream } from 'fs';

const analysis = new Analysis('https://your-cover-api-domain.com');
const buildFile = createReadStream('./build.jar');
// This is a sample settings object that will not run a useful analysis.
// You can omit the settings parameter when calling `run` to start an analysis with default settings.
const settings = { phases: { firstPhase: { timeout: 10 }}};
const options = { outputTests: './tests' };

(async () => {
  const results = await analysis.run({ build: buildFile }, settings, options);
  console.log(`Analysis ended with the status: ${analysis.status}.`);
  console.log(`Produced ${results.length} tests in total.`);
  console.log(`Test files written to ${options.outputTests}.`);
})();
```

For more detailed usage, see the [programmatic interface documentation](docs/programmatic-interface.md).

## Full documentation

- [Programmatic interface](docs/programmatic-interface.md)
  - [Object orientated interface](docs/programmatic-interface.md#object-orientated-interface)
    - [Instantiation](docs/programmatic-interface.md#instantiation)
      - [Resume an analysis](docs/programmatic-interface.md#resume-an-analysis)
    - [Usage](docs/programmatic-interface.md#usage)
      - [Run an analysis (object orientated)](docs/programmatic-interface.md#run-an-analysis-object-orientated)
        - [Stop polling for results](docs/programmatic-interface.md#stop-polling-for-results)
      - [Start an analysis (object orientated)](docs/programmatic-interface.md#start-an-analysis-object-orientated)
      - [Get analysis status (object orientated)](docs/programmatic-interface.md#get-analysis-status-object-orientated)
      - [Get analysis results (object orientated)](docs/programmatic-interface.md#get-analysis-results-object-orientated)
      - [Cancel an analysis (object orientated)](docs/programmatic-interface.md#cancel-an-analysis-object-orientated)
      - [Get default analysis settings (object orientated)](docs/programmatic-interface.md#get-default-analysis-settings-object-orientated)
      - [Get API version (object orientated)](docs/programmatic-interface.md#get-api-version-object-orientated)
      - [Write test files to disk (object orientated)](docs/programmatic-interface.md#write-test-files-to-disk-object-orientated)
    - [Result pagination](docs/programmatic-interface.md#result-pagination)
    - [Lifecycle](docs/programmatic-interface.md#lifecycle)
  - [Low level bindings](docs/programmatic-interface.md#low-level-bindings)
    - [Start an analysis (low level)](docs/programmatic-interface.md#start-an-analysis-low-level)
    - [Get analysis status (low level)](docs/programmatic-interface.md#get-analysis-status-low-level)
    - [Get analysis results (low level)](docs/programmatic-interface.md#get-analysis-results-low-level)
    - [Cancel an analysis (low level)](docs/programmatic-interface.md#cancel-an-analysis-low-level)
    - [Get default analysis settings (low level)](docs/programmatic-interface.md#get-default-analysis-settings-low-level)
    - [Get API version (low level)](docs/programmatic-interface.md#get-api-version-low-level)
    - [Low level options](docs/programmatic-interface.md#low-level-options)
      - [Ignore https rejection](docs/programmatic-interface.md#ignore-https-rejection)
  - [Combining results into test classes](docs/programmatic-interface.md#combining-results-into-test-classes)
    - [Write test files to disk](docs/programmatic-interface.md#write-test-files-to-disk)
    - [Generate a new test class](docs/programmatic-interface.md#generate-a-new-test-class)
    - [Merge results into an existing test class](docs/programmatic-interface.md#merge-results-into-an-existing-test-class)
    - [Filter results](docs/programmatic-interface.md#filter-results)
    - [Group results](docs/programmatic-interface.md#group-results)
- [Command line interface](docs/command-line-interface.md)
- [Tests and checks](docs/tests-and-checks.md)
  - [Linting](docs/tests-and-checks.md#linting)
  - [Unit tests](docs/tests-and-checks.md#unit-tests)
  - [CLI tests](docs/tests-and-checks.md#cli-tests)
  - [Copyright checker](docs/tests-and-checks.md#copyright-checker)
  - [License checker](docs/tests-and-checks.md#license-checker)
  - [Integration tests](docs/tests-and-checks.md#integration-tests)
    - [Mock API](docs/tests-and-checks.md#mock-api)
- [Release procedure](docs/release-procedure.md)
- [Utilities](docs/utilities.md)
  - [Create Release](docs/utilities.md#create-release)
  - [Changelog](docs/utilities.md#changelog)
- [Code standards](docs/code-standards.md)
  - [File naming](docs/code-standards.md#file-naming)
  - [Branches](docs/code-standards.md#branches)
  - [Coding style](docs/code-standards.md#style)
  - [Code documentation](docs/code-standards.md#code-documentation)
- [Contributing guidelines](docs/contributing-guidelines.md)

Copyright 2019 Diffblue Limited. All Rights Reserved.

---
_Source: https://npm.io/package/@diffblue/cover-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._