Skip to content
main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

JSKOS Validation

Test GitHub package version NPM package name standard-readme compliant

Validation for JSKOS data.

This repository contains tools for validating JSKOS data.

Table of Contents

Install

You will unlikely need to directly install jskos-validate. Better use a client such as jskos-cli instead!

Install as dependency to your node project (requires at least NodeJS 8):

npm install --save jskos-validate

Or clone the current version for development:

git clone --recursive https://github.com/gbv/jskos-validate.git
cd jskos-validate
npm install

Usage

This module provides validation methods for each JSKOS object type based on JSON Schemas and additional constraints.

const validate = require("jskos-validate")

let concept = { ... }
validate.concept(concept) // returns true or false

let mapping = { ... }
validate.mapping(mapping) // returns true or false

// ...

See npm module jskos-cli for a command line interface to JSKOS validation.

unknownFields

Setting the option unknownFields to a truthy value will not complain about additional fields. This is useful for instance to validate JSKOS data with newly introduced fields with an old schema.

const validate = require("jskos-validate")

validate.concept(data, { unknownFields: true })

errors and errorMessages

Property errors and errorMessages of the validation function contain errors in detailled format and as array of error message strings, respectively.

const validate = require("jskos-validate")

if (!validate.concept(data)) {
  validate.concept.errorMessages.forEach(console.error)
}

version

Returns the version of JSKOS specification that is used for validation.

validate.version // 0.4.6

Maintainers

Contributing

Please use GitHub issues for bug reports, feature requests or questions.

Maintainers only: To publish a new version on npm via GitHub Actions:

npm run release:patch # or minor, or major

License

MIT © 2019 Verbundzentrale des GBV (VZG)

About

Validation for JSKOS data.

Topics

Resources

License

Packages

No packages published