From e1341bc6d957d70a386c858cbdb64af5f284fd07 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Wed, 21 Mar 2018 18:55:59 +0000 Subject: Move docs to page and add link to docs to README --- packages/website/md/docs/json_schemas/usage.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 packages/website/md/docs/json_schemas/usage.md (limited to 'packages/website/md/docs/json_schemas') diff --git a/packages/website/md/docs/json_schemas/usage.md b/packages/website/md/docs/json_schemas/usage.md new file mode 100644 index 000000000..372c0b541 --- /dev/null +++ b/packages/website/md/docs/json_schemas/usage.md @@ -0,0 +1,14 @@ +The following example shows you how to validate an 0x order using the `@0xproject/json-schemas` package. + +```javascript +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 +``` -- cgit v1.2.3