aboutsummaryrefslogtreecommitdiffstats
path: root/packages/json-schemas/src
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-22 02:51:17 +0800
committerFabio Berger <me@fabioberger.com>2018-03-22 02:51:17 +0800
commitd437a660198a36c585f6cd5fe1bd13643da52ecb (patch)
treeacf00050f0a352f846c421ca1dbf6b9fb69e3417 /packages/json-schemas/src
parent542b46a22feb6187e483aa4e9ccee344a9b64ec6 (diff)
downloaddexon-sol-tools-d437a660198a36c585f6cd5fe1bd13643da52ecb.tar
dexon-sol-tools-d437a660198a36c585f6cd5fe1bd13643da52ecb.tar.gz
dexon-sol-tools-d437a660198a36c585f6cd5fe1bd13643da52ecb.tar.bz2
dexon-sol-tools-d437a660198a36c585f6cd5fe1bd13643da52ecb.tar.lz
dexon-sol-tools-d437a660198a36c585f6cd5fe1bd13643da52ecb.tar.xz
dexon-sol-tools-d437a660198a36c585f6cd5fe1bd13643da52ecb.tar.zst
dexon-sol-tools-d437a660198a36c585f6cd5fe1bd13643da52ecb.zip
Add comments to JSON-schemas public methods
Diffstat (limited to 'packages/json-schemas/src')
-rw-r--r--packages/json-schemas/src/schema_validator.ts24
1 files changed, 24 insertions, 0 deletions
diff --git a/packages/json-schemas/src/schema_validator.ts b/packages/json-schemas/src/schema_validator.ts
index e13326d2a..38ae766e6 100644
--- a/packages/json-schemas/src/schema_validator.ts
+++ b/packages/json-schemas/src/schema_validator.ts
@@ -3,14 +3,26 @@ import values = require('lodash.values');
import { schemas } from './schemas';
+/**
+ * A validator for [JSON-schemas](http://json-schema.org/)
+ */
export class SchemaValidator {
private _validator: Validator;
+ /**
+ * Instantiates a SchemaValidator instance
+ */
constructor() {
this._validator = new Validator();
for (const schema of values(schemas)) {
this._validator.addSchema(schema, schema.id);
}
}
+ /**
+ * 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
+ * instances of that schema.
+ * @param schema The schema to add
+ */
public addSchema(schema: Schema) {
this._validator.addSchema(schema, schema.id);
}
@@ -18,10 +30,22 @@ export class SchemaValidator {
// sub-types (e.g BigNumber) with a simpler string representation. Since BigNumber and other
// complex types implement the `toString` method, we can stringify the object and
// then parse it. The resultant object can then be checked using jsonschema.
+ /**
+ * Validate the JS object conforms to a specific JSON schema
+ * @param instance JS object in question
+ * @param schema Schema to check against
+ * @returns The results of the validation
+ */
public validate(instance: any, schema: Schema): ValidatorResult {
const jsonSchemaCompatibleObject = JSON.parse(JSON.stringify(instance));
return this._validator.validate(jsonSchemaCompatibleObject, schema);
}
+ /**
+ * Check whether an instance properly adheres to a JSON schema
+ * @param instance JS object in question
+ * @param schema Schema to check against
+ * @returns Whether or not the instance adheres to the schema
+ */
public isValid(instance: any, schema: Schema): boolean {
const isValid = this.validate(instance, schema).errors.length === 0;
return isValid;