crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move docs to page and add link to docs to README

Browse Source
This commit is contained in:
Fabio Berger 2018-03-21 18:55:59 +00:00
parent d437a66019
commit e1341bc6d9
3 changed files with 27 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
packages/json-schemas/README.md
View File

@ -2,25 +2,24 @@
Contains 0x-related json schemas
### Read the [Documentation](0xproject.com/docs/json-schemas).
## Installation
```bash
yarn add @0xproject/json-schemas
npm install @0xproject/json-schemas --save
```
## Usage
**Import**
```javascript
import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas';
import { schemas } from '@0xproject/json-schemas';
```
const {orderSchema} = schemas;
const validator = new SchemaValidator();
or
const order = {
...
};
const validatorResult: ValidatorResult = validator.validate(order, orderSchema); // Contains all errors
const isValid: boolean = validator.isValid(order, orderSchema); // Only returns boolean
```javascript
var schemas = require('@0xproject/json-schemas').schemas;
```
## Contributing

14
packages/website/md/docs/json_schemas/usage.md Normal file
View File

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

4
packages/website/ts/containers/json_schemas_documentation.ts
View File

@ -14,12 +14,14 @@ import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
const IntroMarkdown = require('md/docs/json_schemas/introduction');
const InstallationMarkdown = require('md/docs/json_schemas/installation');
const UsageMarkdown = require('md/docs/json_schemas/usage');
const SchemasMarkdown = require('md/docs/json_schemas/schemas');
/* tslint:enable:no-var-requires */
const docSections = {
introduction: 'introduction',
installation: 'installation',
usage: 'usage',
schemaValidator: 'schemaValidator',
schemas: 'schemas',
};
@ -32,6 +34,7 @@ const docsInfoConfig: DocsInfoConfig = {
menu: {
introduction: [docSections.introduction],
install: [docSections.installation],
usage: [docSections.usage],
schemaValidator: [docSections.schemaValidator],
schemas: [docSections.schemas],
},
@ -39,6 +42,7 @@ const docsInfoConfig: DocsInfoConfig = {
[docSections.introduction]: IntroMarkdown,
[docSections.installation]: InstallationMarkdown,
[docSections.schemas]: SchemasMarkdown,
[docSections.usage]: UsageMarkdown,
},
sectionNameToModulePath: {
[docSections.schemaValidator]: ['"json-schemas/src/schema_validator"'],