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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-37.3.0.tar.gz
Algorithm Hash digest
SHA256 237202a1eeebd301e3fe04a56c0bf64004a34f568fd6362f101227ab093bb417
MD5 656a2fbdce3aeebadcd2a5220ed86b6e
BLAKE2b-256 537110024918174b09e9b8a14e5e750bbab995188523144e31e4244591176097

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hestia_earth_schema_validation-37.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c42d1b2c77ea38ccb1bdbc1a4f3e15649c81f839fe9b4ed7f3b0555dd4bd9c77
MD5 f1374df2be55499b68b46f7c28949d37
BLAKE2b-256 5e4d9068eec3dbee8445ec93cc8a5d5742585de68478a1ac74e9f989e270664d

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