data-ok

Convenience method to wrap json-schema validation into a single function.

The single API method exported: isValid(schema, data), does three things:

1. Dereference the schema to resolve all external references
2. Validate the resulting fullSchema
3. Validate the data against the fullSchema.

Usage

API

/**
 * Provides a convenience interface to validate a data object
 * against a dereferenced schema object.
 *
 * Throws a SchemaError if either the schema or data is not valid.
 * SchemaError provides an `errors` property, detailing individual
 * violations.
 *
 * @async
 * @param schema schema to validate data against
 * @param data data to validate
 * @returns Promise<boolean>
 */
export declare const isValid: (schema: any, data?: any) => Promise<boolean>;

CLI

  Usage: data-ok [options]


  Options:

    -V, --version          output the version number
    -d, --data <data>      data to validate {json, yaml}
    -s, --schema <schema>  schema to use for validation {json, yaml}
    -h, --help             output usage information

Development Tooling

• Development tooling
• Changelog

License

Apache-2.0

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Support

Bugs, PRs, comments, suggestions welcomed!