# @0x/assert

> Provides a standard way of performing type and schema validation across 0x projects

Latest version **3.0.36** (published 2023-04-07) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @0x/assert
pnpm add @0x/assert
yarn add @0x/assert
bun add @0x/assert
```

## 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.36 |
| Published | 2023-04-07 |
| First published | 2018-10-18 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=6.12 |
| Dependencies | 6 |
| Unpacked size | 42.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 98 |
| Maintainers | rhinodavid, mwelche, savdont, eobbad, aeph4muh, idokleinman, jadetran, kyuc, henryzhu, tobernguyen, dex_tracker, dekz, amirbandeali, phil-ociraptor |

## Links

- npm: https://www.npmjs.com/package/@0x/assert
- Repository: https://github.com/0xProject/tools
- Homepage: https://github.com/0xProject/tools/tree/main/assert
- Issues: https://github.com/0xProject/tools/issues
- npm.io page: https://npm.io/package/@0x/assert

## Dependencies (6)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [@0x/utils](https://npm.io/package/@0x/utils.md) ^7.0.0
- [valid-url](https://npm.io/package/valid-url.md) ^1.0.9
- [@types/node](https://npm.io/package/@types/node.md) 12.12.54
- [@0x/json-schemas](https://npm.io/package/@0x/json-schemas.md) ^6.4.6
- [@0x/typescript-typings](https://npm.io/package/@0x/typescript-typings.md) ^5.3.2

## Recent versions

- 3.0.36 (latest) — 2023-04-07
- 2.2.0-beta.3 (protocolV3) — 2019-12-02
- 3.0.35 — 2022-08-18
- 3.0.34 — 2022-03-16
- 3.0.33 — 2022-03-16
- 3.0.32 — 2022-02-26
- 3.0.31 — 2022-01-19
- 3.0.30 — 2021-09-23
- 3.0.29 — 2021-08-25
- 3.0.28 — 2021-06-28
- 3.0.27 — 2021-04-28
- 3.0.26 — 2021-04-26
- 3.0.25 — 2021-04-26
- 3.0.24 — 2021-04-26
- 3.0.23 — 2021-04-06
- … 54 more at https://npm.io/package/@0x/assert/versions

## README

## @0x/assert

Standard type and schema assertions to be used across all 0x projects and packages

## Installation

```bash
yarn add @0x/assert
```

## Usage

```typescript
import { assert } from '@0x/assert';

assert.isValidBaseUnitAmount('baseUnitAmount', baseUnitAmount);
```

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

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

## 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=@0x/assert yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0x/assert yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```

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