# @agreed/client

> agreed client, testing utilities

Latest version **6.0.0** (published 2024-03-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @agreed/client
pnpm add @agreed/client
yarn add @agreed/client
bun add @agreed/client
```

Provides the command `client`.

## Health

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

Positive: no vulnerabilities; high maintenance score.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 6.0.0 |
| Published | 2024-03-14 |
| First published | 2019-10-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 10.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 215 |
| Author | yosuke-furukawa |
| Maintainers | yosuke-furukawa, maxmellon |
| Keywords | agreed, client, test, confirmation |

## Links

- npm: https://www.npmjs.com/package/@agreed/client
- Repository: https://github.com/recruit-tech/agreed
- Homepage: https://github.com/recruit-tech/agreed#readme
- Issues: https://github.com/recruit-tech/agreed/issues
- npm.io page: https://npm.io/package/@agreed/client

## Dependencies (3)

- [colo](https://npm.io/package/colo.md) ^1.0.0
- [is-empty](https://npm.io/package/is-empty.md) ^1.0.0
- [@agreed/core](https://npm.io/package/@agreed/core.md) ^6.0.0

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 6.0.0 (latest) — 2024-03-14
- 5.3.2-alpha.0 — 2022-08-25
- 5.3.1 — 2022-08-16
- 5.3.0 — 2022-07-21
- 5.2.1 — 2021-07-06
- 5.2.0 — 2021-01-29
- 5.1.10 — 2020-09-01
- 5.1.9 — 2020-08-07
- 5.1.8 — 2020-08-03
- 5.1.7 — 2020-05-28
- 5.1.6 — 2020-05-27
- 5.1.5 — 2020-04-06
- 5.1.4 — 2020-04-06
- 5.1.3 — 2020-03-30
- 5.1.2 — 2020-03-30
- … 13 more at https://npm.io/package/@agreed/client/versions

## README

agreed-client
===================
[![Build Status](https://travis-ci.org/recruit-tech/agreed-client.svg?branch=master)](https://travis-ci.org/recruit-tech/agreed-client)

An agreed client for check response.

# Install

```
$ npm install agreed-client -D
```

# Usage

```javascript
const agreedClient = require('agreed-client')

const {
  client,
  agrees,
  reporter,
} = agreedClient({
  path: './test/agreed.json5', // required
  scheme: 'http', // optional, default is http
  host: 'localhost', // optional, default is localhost
  port: 30103, // optional, default is 80
  defaultRequestHeaders: {
    'x-jwt-token': 'foobarbaz'
  }
})

client.requestPromise(agrees)
  .then(reporter)
  .catch((e) => {
    console.error(e)
    process.exit(1)
  })
```

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