🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more

schema-utils

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install
s

schema-utils

webpack Validation Utils

4.3.2
latest
99

Supply Chain Security

100

Vulnerability

100

Quality

88

Maintenance

100

License

Version published
Weekly downloads
90M
6.72%
Maintainers
2
Weekly downloads
 
Created
Issues
4

What is schema-utils?

The schema-utils package is a utility library for validating options against a JSON Schema. It is commonly used in the context of webpack loaders and plugins to validate configuration objects. It provides functions to validate options, throw useful errors, and ensure that the configuration adheres to a specified schema.

What are schema-utils's main functionalities?

Validation of options

This feature allows users to validate an options object against a predefined JSON Schema. The 'validate' function takes a schema, options, and a configuration object that includes the name of the plugin or loader using the validation.

const { validate } = require('schema-utils');
const schema = {
  type: 'object',
  properties: {
    name: {
      type: 'string'
    }
  },
  required: ['name']
};
const options = { name: 'Example' };
validate(schema, options, { name: 'MyPlugin' });

Custom error messages

This feature allows users to provide custom error messages in the schema that will be displayed when validation fails. The 'validate' function will throw an error with these messages if the options do not match the schema.

const { validate } = require('schema-utils');
const schema = {
  type: 'object',
  properties: {
    age: {
      type: 'number',
      description: 'Age must be a number'
    }
  },
  required: ['age']
};
const options = { age: 'old' };
try {
  validate(schema, options, { name: 'AgeChecker' });
} catch (error) {
  // Custom error handling
}

Other packages similar to schema-utils

Keywords

FAQs

Package last updated on 22 Apr 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts