xsd-schema-validator/README.md

A (XSD) schema validator for nodejs

# xsd-schema-validator

[![CI](https://github.com/nikku/node-xsd-schema-validator/actions/workflows/CI.yml/badge.svg)](https://github.com/nikku/node-xsd-schema-validator/actions/workflows/CI.yml)

A (XSD) schema validator for [NodeJS](nodejs.org) that uses [Java](https://www.java.com) to perform the actual validation. [:arrow_right: Why?](#why)


## Prerequisites

Under the hood, this utility uses Java to do the actual validation. 

It assumes that `javac` and `java` are on the path. If a `JAVA_HOME` environment variable exists it uses that to locate an installed JDK. 

On some platforms, i.e. [Mac OSX](http://www.mkyong.com/java/how-to-set-java_home-environment-variable-on-mac-os-x/) you need to define `JAVA_HOME` manually.


## Installation

Install the package via [npm](http://npmjs.org):

```
npm install --save xsd-schema-validator
```


## Usage

Use in your application:

```javascript
var validator = require('xsd-schema-validator');

var xmlStr = '<foo:bar />';

try {
  const result = await validator.validateXML(xmlStr, 'resources/foo.xsd');

  result.valid; // true
} catch (err) {
  console.error('validation error', err);
}
```

You may validate readable streams:

```javascript
var xmlStream = fs.createReadableStream('some.xml');

const result = await validator.validateXML(xmlStream);
```

You may validate files, too:

```javascript
const result = validator.validateXML({ file: 'some.xml' }, ...);
```

## Why

Because Java can do schema validation and NodeJS cannot.


## License

MIT