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-36.2.2.tar.gz (69.5 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-36.2.2-py3-none-any.whl (116.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-36.2.2.tar.gz
Algorithm Hash digest
SHA256 fd7871aad8830e351001cb1de48e5699f207dce5476c4812b6684149842d4d87
MD5 2f98d95cdbf6934abbcc5cca7397c460
BLAKE2b-256 d38901e4947d2afc1974051da26435b99b5b8a59aab80742f8c09c805ca896cc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-36.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2bc78e96978db0e73efdfe86d87e198c284f57e0d1225673481fd81071a4d83b
MD5 bf445151a5928aaa65488949e4bad4c6
BLAKE2b-256 cf675da16b7ac3239c734b96583608deb757479c359395f6800c57636ad03750

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