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.4.tar.gz (69.7 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.4-py3-none-any.whl (116.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-36.2.4.tar.gz
Algorithm Hash digest
SHA256 a0170e43846c7855472f3edd0ee262333a1b99d8637422821cd1b23b6c2c121e
MD5 b9e8d8ebe4a12c64613fd8cf226b2f6a
BLAKE2b-256 b108172d12e6727ca27925bfd680e9f2ca4da481767e5e7b5388e87f623d3bdd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-36.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d4717913476fbcce1e8b0c618a8b63d5e5199831653694278b98a714482dd95d
MD5 8f812efbb1ab24794141bc7712fab8fb
BLAKE2b-256 b22a349b2827162cd27128555aba4017280997275c222d70ebbf6d22a8ade9ba

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