Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@0x/assert

0xProject18.5kApache-2.03.0.36TypeScript support: included

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

readme

@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/@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 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

changelog

CHANGELOG

v3.0.36 - April 7, 2023

* Dependencies updated

v3.0.35 - August 18, 2022

* Dependencies updated

v3.0.34 - March 16, 2022

* Dependencies updated

v3.0.33 - March 16, 2022

* Dependencies updated

v3.0.32 - February 26, 2022

* Dependencies updated

v3.0.31 - January 19, 2022

* Dependencies updated

v3.0.30 - September 23, 2021

* Dependencies updated

v3.0.29 - August 25, 2021

* Dependencies updated

v3.0.28 - June 28, 2021

* Dependencies updated

v3.0.27 - April 28, 2021

* Dependencies updated

v3.0.26 - April 26, 2021

* Dependencies updated

v3.0.25 - April 26, 2021

* Dependencies updated

v3.0.24 - April 26, 2021

* Dependencies updated

v3.0.23 - April 6, 2021

* Dependencies updated

v3.0.22 - March 24, 2021

* Dependencies updated

v3.0.21 - January 7, 2021

* Dependencies updated

v3.0.20 - January 5, 2021

* Dependencies updated

v3.0.19 - December 2, 2020

* Dependencies updated

v3.0.18 - December 1, 2020

* Add assert.doesMatchRegex

v3.0.17 - October 29, 2020

* Dependencies updated

v3.0.16 - October 29, 2020

* Dependencies updated

v3.0.15 - October 29, 2020

* Dependencies updated

v3.0.14 - October 28, 2020

* Dependencies updated

v3.0.13 - October 21, 2020

* Dependencies updated

v3.0.12 - October 21, 2020

* Dependencies updated

v3.0.11 - October 20, 2020

* Dependencies updated

v3.0.10 - October 20, 2020

* Dependencies updated

v3.0.9 - July 15, 2020

* Dependencies updated

v3.0.8 - June 24, 2020

* Dependencies updated

v3.0.7 - February 25, 2020

* Dependencies updated

v3.0.6 - February 8, 2020

* Dependencies updated

v3.0.5 - February 6, 2020

* Dependencies updated

v3.0.4 - January 22, 2020

* Dependencies updated

v3.0.3 - January 6, 2020

* Dependencies updated

v3.0.2 - December 17, 2019

* Dependencies updated

v3.0.1 - December 9, 2019

* Dependencies updated

v3.0.0 - December 2, 2019

* Dependencies updated

v2.2.0-beta.3 - December 2, 2019

* Dependencies updated

v2.2.0-beta.2 - November 17, 2019

* Dependencies updated

v2.2.0-beta.1 - November 7, 2019

* Dependencies updated

v2.2.0-beta.0 - October 3, 2019

* Dependencies updated

v2.1.6 - September 17, 2019

* Dependencies updated

v2.1.5 - September 3, 2019

* Dependencies updated

v2.1.4 - August 22, 2019

* Dependencies updated

v2.1.3 - August 8, 2019

* Dependencies updated

v2.1.2 - July 31, 2019

* Dependencies updated

v2.1.1 - July 24, 2019

* Dependencies updated

v2.1.0 - July 13, 2019

* Add new assertions: `isArray`, `isBlockParam` and `isNumberOrBigNumber` (#1823)
* Add `isNumberLike()` assertion (#1819)

v2.0.10 - May 10, 2019

* Dependencies updated

v2.0.9 - April 11, 2019

* Dependencies updated

v2.0.8 - March 21, 2019

* Dependencies updated

v2.0.7 - March 20, 2019

* Dependencies updated

v2.0.6 - March 1, 2019

* Dependencies updated

v2.0.5 - February 26, 2019

* Dependencies updated

v2.0.4 - February 25, 2019

* Dependencies updated

v2.0.3 - February 9, 2019

* Dependencies updated

v2.0.2 - February 7, 2019

* Dependencies updated

v2.0.1 - February 6, 2019

* Dependencies updated

v2.0.0 - February 5, 2019

* Upgrade the bignumber.js to v8.0.2 (#1517)

v1.0.23 - January 15, 2019

* Dependencies updated

v1.0.22 - January 11, 2019

* Dependencies updated

v1.0.21 - January 9, 2019

* Dependencies updated

v1.0.20 - December 13, 2018

* Dependencies updated

v1.0.19 - December 11, 2018

* Dependencies updated

v1.0.18 - November 21, 2018

* Dependencies updated

v1.0.17 - November 14, 2018

* Dependencies updated

v1.0.16 - November 12, 2018

* Dependencies updated

v1.0.15 - November 9, 2018

* Dependencies updated

v1.0.14 - October 18, 2018

* Dependencies updated

v1.0.13 - October 4, 2018

* Dependencies updated

v1.0.12 - September 28, 2018

* Dependencies updated

v1.0.11 - September 25, 2018

* Dependencies updated

v1.0.10 - September 25, 2018

* Dependencies updated

v1.0.9 - September 21, 2018

* Dependencies updated

v1.0.8 - September 5, 2018

* Dependencies updated

v1.0.7 - August 27, 2018

* Dependencies updated

v1.0.6 - August 24, 2018

* Dependencies updated

v1.0.5 - August 14, 2018

* Dependencies updated

v1.0.4 - July 26, 2018

* Dependencies updated

v1.0.3 - July 26, 2018

* Dependencies updated

v1.0.2 - July 26, 2018

* Dependencies updated

v1.0.1 - July 23, 2018

* Dependencies updated

v1.0.0 - July 19, 2018

* Fix bug in string enum assertion. We erroneously were checking against the enum keys, not values (#821)

v0.2.14 - July 18, 2018

* Dependencies updated

v0.2.13 - July 9, 2018

* Dependencies updated

v0.2.12 - June 19, 2018

* Dependencies updated

v0.2.11 - May 31, 2018

* Incorrect publish that was unpublished

v0.2.10 - May 22, 2018

* Dependencies updated

v0.2.9 - May 4, 2018

* Dependencies updated

v0.2.8 - May 4, 2018

* Dependencies updated

v0.2.7 - April 18, 2018

* Dependencies updated

v0.2.6 - April 11, 2018

* Dependencies updated

v0.2.5 - April 2, 2018

* Dependencies updated

v0.2.4 - April 2, 2018

* Dependencies updated

v0.2.0 - March 7, 2018

* Rename `isHttpUrl` to `isWebUri` (#412)

v0.1.0 - March 3, 2018

* Remove isETHAddressHex checksum address check and assume address will be lowercased  (#373)
* Add an optional parameter `subSchemas` to `doesConformToSchema` method (#385)

v0.0.18 - February 8, 2017

* Fix publishing issue where .npmignore was not properly excluding undesired content (#389)

v0.0.4 - November 13, 2017

* Re-publish Assert previously published under NPM package @0xproject/0x-assert
* Added assertion isValidBaseUnitAmount which checks both that the value is a valid bigNumber and that it does not contain decimals.