validate-value

validate-value

validate-value validates values against JSON schemas.

Status

Category	Status
Version
Dependencies
Dev dependencies
Build
License

Installation

$ npm install validate-value

Quick start

First you need to integrate validate-value into your application:

const { Value } = require('validate-value');

If you use TypeScript, use the following code instead:

import { Value } from 'validate-value';

Then, create a new instance and provide a JSON schema that you would like to use for validation:

const value = new Value({
  type: 'object',
  properties: {
    username: { type: 'string' },
    password: { type: 'string' }
  },
  additionalProperties: false,
  required: [ 'username', 'password' ]
});

Afterwards, you may use the validate function to validate a value:

const user = {
  username: 'Jane Doe',
  password: 'secret'
};

try {
  value.validate(user);
} catch (ex) {
  // ...
}

By default, the error message uses value as identifier and . as the separator for the object that is validated, but sometimes you may want to change this. Therefor, provide the desired identifier and separator as second parameter to the validate function:

const user = {
  username: 'Jane Doe',
  password: 'secret'
};

try {
  value.validate(user, { valueName: 'person', separator: '/' });
} catch (ex) {
  // ...
}

From time to time, you may not be interested in the actual error, but only in the fact whether the given object is valid or not. For these cases, use the isValid function:

const user = {
  username: 'Jane Doe',
  password: 'secret'
};

console.log(value.isValid(user));
// => true

Running the build

To build this module use roboter.

$ npx roboter