Skip to content

Latest commit

 

History

History

assert

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
coverage
coverage
 
 
src
src
 
 
test
test
 
 
.npmignore
.npmignore
 
 
CHANGELOG.json
CHANGELOG.json
 
 
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 
tslint.json
tslint.json
 
 

README.md

@0x/assert

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

Installation

yarn add @0x/assert

Usage

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

assert.isValidBaseUnitAmount('baseUnitAmount', baseUnitAmount);

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

"compilerOptions": {
    "typeRoots": ["node_modules/@dexon-foundation/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=@0x/assert yarn build

Or continuously rebuild on change:

PKG=@0x/assert yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test