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-38.2.0.tar.gz (70.8 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-38.2.0-py3-none-any.whl (117.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-38.2.0.tar.gz
Algorithm Hash digest
SHA256 78c95b29a5f741c48cf913f147c6e118de29a7861d5296e1cf1383fa8c085c12
MD5 6869bca833e3d9d759e5cc44e5d8e691
BLAKE2b-256 628afaf843b4f6efcaeeb865c75c247247898cb32241adbe075dbd2727a5a034

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-38.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 91900680f9b1cd502e63ca5d1a8351dadd0f1237f52e31fffe3a09e6dcaa6de0
MD5 639062477651b1e75c0b033a221308dd
BLAKE2b-256 93f614cb232a7a97b3794f4693cbb343569f5c65fc98509531191d6562b6c212

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