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

Updated CHANGELOGS & MD docs

Browse Source
This commit is contained in:
fabioberger
2019-11-07 20:42:58 +00:00
parent c93b02d55e
commit 6fd96a6fd7
110 changed files with 8735 additions and 23569 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/json-schemas/docs/reference.mdx
View File

@@ -9,7 +9,7 @@ A validator for [JSON-schemas](http://json-schema.org/)
\+ **new SchemaValidator**(): *[SchemaValidator](#class-schemavalidator)*
*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/json-schemas/src/schema_validator.ts#L15)*
*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/json-schemas/src/schema_validator.ts#L15)*
Instantiates a SchemaValidator instance
@@ -21,7 +21,7 @@ Instantiates a SchemaValidator instance
▸ **addSchema**(`schema`: `Schema`): *void*
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/json-schemas/src/schema_validator.ts#L32)*
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/json-schemas/src/schema_validator.ts#L32)*
Add a schema to the validator. All schemas and sub-schemas must be added to
the validator before the `validate` and `isValid` methods can be called with
@@ -41,7 +41,7 @@ ___
▸ **isValid**(`instance`: any, `schema`: `Schema`): *boolean*
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/json-schemas/src/schema_validator.ts#L57)*
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/json-schemas/src/schema_validator.ts#L57)*
Check whether an instance properly adheres to a JSON schema
@@ -62,7 +62,7 @@ ___
▸ **validate**(`instance`: any, `schema`: `Schema`): *`ValidatorResult`*
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/json-schemas/src/schema_validator.ts#L46)*
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/json-schemas/src/schema_validator.ts#L46)*
Validate the JS object conforms to a specific JSON schema