Skip to main content

HESTIA Schema Validation library

Project description

HESTIA Schema Validation

Module to validate data using the HESTIA Schema and Ajv.

Install

npm install @hestia-earth/schema @hestia-earth/schema-validation

Example validating JSON

const { SchemaType } = require('@hestia-earth/schema');
const { validator } = require('@hestia-earth/schema-validation/validate');

// Set to `true` to validate existing Nodes (@type/@id) or `false` for Nodes to upload (type/id)
const strictMode = false;
// Initialise the validation function, do this only once
const schemaValidation = validator(undefined, strictMode);

const node = {
  type: SchemaType.Cycle,
  id: 'my first cycle'
};

(async () => {
  const { success, errors } = await schemaValidation(node);
  console.log(success);
  // list of errors in Ajv formatting. See https://github.com/ajv-validator/ajv/tree/v6.12.6#validation-errors
  console.log(errors);
})();

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hestia_earth_schema_validation-37.1.0.tar.gz (70.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hestia_earth_schema_validation-37.1.0-py3-none-any.whl (116.6 kB view details)

Uploaded Python 3

File details

Details for the file hestia_earth_schema_validation-37.1.0.tar.gz.

File metadata

File hashes

Hashes for hestia_earth_schema_validation-37.1.0.tar.gz
Algorithm Hash digest
SHA256 0a010934dc4fe07684fd8a99ccd705f67924d8ce9c1031582c300593ff2f6ee5
MD5 14dc70c9a45a4c984c8843deca5fb560
BLAKE2b-256 c3d8c256325a6ab1dd77811175fd1c1378e38ec261c4d497f28b4800b2b5bac3

See more details on using hashes here.

File details

Details for the file hestia_earth_schema_validation-37.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for hestia_earth_schema_validation-37.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3c4544143b74b75df3d624a5c4a35638192172be2c4e72f2739a7e5c30594ae9
MD5 558e0a777c06dac513bbc98fb93582ca
BLAKE2b-256 6ff6f1702f0bddff25bd1ac8ccf664780731faef6fefdc718696403abb85b9ad

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page