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.3.1.tar.gz (70.6 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.3.1-py3-none-any.whl (117.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-37.3.1.tar.gz
Algorithm Hash digest
SHA256 67e9df8fad55bf055d849345e95b1a7476e259dd7df5db948217b200c86b1c44
MD5 98fe1ee80bf4341ae0c069d2215a4af1
BLAKE2b-256 cb01cd461c8e72e26f19fe738ed9f6d5f24d70615b40ebb1a9d23c966f9f5f57

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-37.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5bd4744a06487f3d14acfa746db742cb53f106ecee9104a4f27b81d9200e379b
MD5 fc391529a9b07f2650e1e5dbf6b35523
BLAKE2b-256 d728b8003080bea50d2d29ab83ec1f62e3535cc395a2fa3f44146f90b0d9cb66

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