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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-37.2.2.tar.gz
Algorithm Hash digest
SHA256 08cbcbbf746845cc09f918620e9de6de90c6bd81520f20561191e94a1855b870
MD5 de838743c056b944355a051648016eb9
BLAKE2b-256 381d7ce9a404345e6786d06c623d8b0c91be29e941d28b1e56d9e703cc8565f2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-37.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 36f03a552a22bb78531df6fad150e321f3c21865aec2140ff957612949fbb83e
MD5 97e16938e21fe7405b923e414996f2b4
BLAKE2b-256 92d749108074ca529033706167a790eba2635f659de3adfde565ddac2aa211b9

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