@0xproject/assert

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

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
1,35413Apr 24, 2021May 23, 2017Minified + gzip package size for @0xproject/assert in KB

Readme

@0xproject/assert

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

Installation

yarn add @0xproject/assert

Usage

import { assert } from '@0xproject/assert';

assert.isValidBaseUnitAmount('baseUnitAmount', baseUnitAmount);

If your project is in TypeScript, add the following to your tsconfig.json:

"compilerOptions": {
    "typeRoots": ["node_modules/@0xproject/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 before getting started.

Install dependencies

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

yarn config set workspaces-experimental true

Then install dependencies

yarn install

Build

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

PKG=@0xproject/assert yarn build

Or continuously rebuild on change:

PKG=@0xproject/assert yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.