aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs/json_schemas/3/usage.md
diff options
context:
space:
mode:
authorKadinsky <kandinsky454@protonmail.ch>2018-10-19 04:15:31 +0800
committerGitHub <noreply@github.com>2018-10-19 04:15:31 +0800
commit65d85ca5008fe0c307506b388d6ace858122f8ad (patch)
treef8d4b0aa654eab3f26bdbfe40dea6fb7e105e864 /packages/website/md/docs/json_schemas/3/usage.md
parent857eb95ac0f8299fe517321cb805a836232222bc (diff)
parentc2038eae5bc02fc24edcb369381b0d9699aed0aa (diff)
downloaddexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.tar
dexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.tar.gz
dexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.tar.bz2
dexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.tar.lz
dexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.tar.xz
dexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.tar.zst
dexon-sol-tools-65d85ca5008fe0c307506b388d6ace858122f8ad.zip
Merge pull request #1158 from 0xProject/docSectionFixes
Update Doc Ref Markdown Sections
Diffstat (limited to 'packages/website/md/docs/json_schemas/3/usage.md')
-rw-r--r--packages/website/md/docs/json_schemas/3/usage.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/packages/website/md/docs/json_schemas/3/usage.md b/packages/website/md/docs/json_schemas/3/usage.md
new file mode 100644
index 000000000..2b72eeaad
--- /dev/null
+++ b/packages/website/md/docs/json_schemas/3/usage.md
@@ -0,0 +1,14 @@
+The following example shows you how to validate a 0x order using the `@0x/json-schemas` package.
+
+```javascript
+import {SchemaValidator, ValidatorResult, schemas} from '@0x/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
+```