diff options
author | Brandon Millman <brandon.millman@gmail.com> | 2017-11-14 08:32:01 +0800 |
---|---|---|
committer | Brandon Millman <brandon.millman@gmail.com> | 2017-11-14 22:42:50 +0800 |
commit | 56b5619d24b44d23f770b58b0c9e1d4a63b89aca (patch) | |
tree | 52c047aa9ce6dbd5af93f495dbb21a8c3a662a6f /packages/json-schemas/README.md | |
parent | 08963f269b543d0f6f125ff77efdda23339865ed (diff) | |
download | dexon-0x-contracts-56b5619d24b44d23f770b58b0c9e1d4a63b89aca.tar.gz dexon-0x-contracts-56b5619d24b44d23f770b58b0c9e1d4a63b89aca.tar.zst dexon-0x-contracts-56b5619d24b44d23f770b58b0c9e1d4a63b89aca.zip |
Add json-schemas package to mono repo
Diffstat (limited to 'packages/json-schemas/README.md')
-rw-r--r-- | packages/json-schemas/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md new file mode 100644 index 000000000..e9f80e106 --- /dev/null +++ b/packages/json-schemas/README.md @@ -0,0 +1,15 @@ +Contains 0x-related json schemas + +## Usage: +``` +import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas'; + +const {orderSchema} = schemas; +const validator = new SchemaValidator(); + +const order = { + ... +}; +const validatorResult: ValidatorResult = validator.validate(order, orderSchema); // Contains all errors +const isValid: boolean = validator.isValid(order, orderSchema); // Only returns boolean +``` |