# @0xproject/connect

> A javascript library for interacting with the standard relayer api

Latest version **3.0.1** (published 2018-10-04) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @0xproject/connect
pnpm add @0xproject/connect
yarn add @0xproject/connect
bun add @0xproject/connect
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2018-10-04 |
| First published | 2017-11-22 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=6.12 |
| Dependencies | 11 |
| Unpacked size | 89.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1408 |
| Author | Brandon Millman |
| Maintainers | albrow, amirbandeali, bchillman, dekz, fberger, fragosti, logvinov |
| Keywords | connect, 0xproject, ethereum, tokens, exchange |

## Links

- npm: https://www.npmjs.com/package/@0xproject/connect
- Repository: https://github.com/0xProject/0x-monorepo
- Homepage: https://github.com/0xProject/0x-monorepo/packages/connect/README.md
- Issues: https://github.com/0xProject/0x-monorepo/issues
- npm.io page: https://npm.io/package/@0xproject/connect

## Dependencies (11)

- [uuid](https://npm.io/package/uuid.md) ^3.3.2
- [sinon](https://npm.io/package/sinon.md) ^4.0.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.5
- [websocket](https://npm.io/package/websocket.md) ^1.0.25
- [query-string](https://npm.io/package/query-string.md) ^5.0.1
- [@0xproject/types](https://npm.io/package/@0xproject/types.md) ^1.1.4
- [@0xproject/utils](https://npm.io/package/@0xproject/utils.md) ^2.0.2
- [@0xproject/assert](https://npm.io/package/@0xproject/assert.md) ^1.0.13
- [@0xproject/order-utils](https://npm.io/package/@0xproject/order-utils.md) ^1.0.7
- [@0xproject/json-schemas](https://npm.io/package/@0xproject/json-schemas.md) ^1.0.7
- [@0xproject/typescript-typings](https://npm.io/package/@0xproject/typescript-typings.md) ^3.0.2

## Recent versions

- 3.0.1 (latest) — 2018-10-04
- 3.0.0 — 2018-09-28
- 2.0.4 — 2018-09-25
- 2.0.3 — 2018-09-25
- 2.0.2 — 2018-09-21
- 2.0.1 — 2018-09-19
- 2.0.0 — 2018-09-05
- 2.0.0-rc.2 — 2018-08-27
- 2.0.0-rc.1 — 2018-08-24
- 1.0.5 — 2018-08-14
- 1.0.4 — 2018-07-26
- 1.0.3 — 2018-07-26
- 1.0.2 — 2018-07-26
- 1.0.0 — 2018-07-19
- 0.6.17 — 2018-07-18
- … 34 more at https://npm.io/package/@0xproject/connect/versions

## README

## @0xproject/connect

This repository contains a Javascript library that makes it easy to interact with Relayers that conform to the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api)

## Installation

```bash
yarn add @0xproject/connect
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
}
```

## Usage

*   [Docs](https://0xproject.com/docs/connect)
*   [Tutorials](https://0xproject.com/wiki#connect)

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

```bash
PKG=@0xproject/connect yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0xproject/connect yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```

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