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.2.3.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.2.3-py3-none-any.whl (116.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-37.2.3.tar.gz
Algorithm Hash digest
SHA256 0a7cfb2d302bd0cd7469aa4f91b18d37fd68a6e41f09e86095b474122cc25bc1
MD5 9c5671e78403cdc017a1db2c93cd8c74
BLAKE2b-256 24c2b9aea7a0c6da2beb760780170c83a261d81dadae140ca2fb41fdfc3a2a0d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-37.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4ffc2a7931046b034d32597b6c232abada4fad6b78eb2a8caf3eeee6dd1bbb16
MD5 10bde38baa2f25209b6277d397b34469
BLAKE2b-256 c6c13754e271ed6b45304a2bc10653d5c694904f77f0e4a75fe7561a99069564

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