celebrate vs express-joi-validation vs express-validator vs joi
Node.js Validation Libraries
celebrateexpress-joi-validationexpress-validatorjoiSimilar Packages:

Node.js Validation Libraries

Validation libraries in Node.js are essential tools for ensuring that incoming data meets specific criteria before being processed by the application. They help maintain data integrity, improve security by preventing invalid data from being processed, and enhance the user experience by providing immediate feedback on input errors. Each of these libraries offers unique features and approaches to data validation, making them suitable for different use cases in web development.

Npm Package Weekly Downloads Trend

3 Years

Github Stars Ranking

Stat Detail

Package
Downloads
Stars
Size
Issues
Publish
License
celebrate01,34927.8 kB12 years agoMIT
express-joi-validation010421.9 kB109 months agoMIT
express-validator06,244146 kB814 months agoMIT
joi021,198557 kB1914 months agoBSD-3-Clause

Feature Comparison: celebrate vs express-joi-validation vs express-validator vs joi

Integration with Express

  • celebrate:

    Celebrate is designed specifically for use with Express.js, providing middleware that integrates seamlessly with the request-response cycle. It allows you to validate incoming requests directly in your route definitions, making it easy to enforce data integrity as part of your route handling.

  • express-joi-validation:

    Express-joi-validation offers a straightforward way to integrate Joi validation with Express routes. It provides middleware that allows you to define validation rules alongside your route handlers, ensuring that incoming data is validated before reaching your business logic.

  • express-validator:

    Express-validator is a versatile validation library that can be used with any Express route. It allows you to define validation rules directly in the route handlers, offering flexibility in how you implement validation logic throughout your application.

  • joi:

    Joi is a standalone validation library that can be used independently of Express. While it does not provide middleware for Express, it can be easily integrated into any part of your application where data validation is needed.

Validation Complexity

  • celebrate:

    Celebrate leverages Joi's powerful schema validation capabilities, allowing you to define complex validation rules with ease. You can create nested schemas and use Joi's extensive validation methods to ensure that your data meets specific requirements before processing.

  • express-joi-validation:

    Express-joi-validation allows you to define complex validation rules using Joi schemas, making it easy to validate deeply nested objects and arrays. It provides a clean and concise way to enforce validation logic in your Express routes.

  • express-validator:

    Express-validator supports a wide range of validation and sanitization methods, allowing you to define both simple and complex validation rules directly in your route handlers. It is particularly useful for applications that require extensive validation logic across various fields.

  • joi:

    Joi excels in defining complex validation schemas, allowing you to create detailed and hierarchical validation rules. It supports a variety of data types and provides powerful validation methods, making it suitable for applications with intricate data structures.

Error Handling

  • celebrate:

    Celebrate automatically handles validation errors by returning a standardized error response when validation fails. This makes it easy to provide consistent feedback to users about what went wrong with their input.

  • express-joi-validation:

    Express-joi-validation provides built-in error handling capabilities, allowing you to catch and respond to validation errors in a structured manner. You can customize the error messages returned to the client, improving the user experience.

  • express-validator:

    Express-validator offers comprehensive error handling features, allowing you to access validation errors and format them as needed. You can customize the response based on the validation results, providing clear feedback to users about input errors.

  • joi:

    Joi provides detailed error messages when validation fails, allowing you to customize how errors are presented to users. However, it does not handle errors automatically in the context of Express, so you will need to implement your own error handling logic.

Learning Curve

  • celebrate:

    Celebrate has a relatively low learning curve, especially for developers familiar with Joi. Its integration with Express simplifies the validation process, making it accessible for those new to data validation in Node.js applications.

  • express-joi-validation:

    Express-joi-validation is straightforward to learn, particularly for developers already familiar with Joi. Its simple API allows for quick adoption, making it a good choice for teams looking to implement validation without a steep learning curve.

  • express-validator:

    Express-validator has a moderate learning curve due to its extensive feature set. While it is flexible and powerful, understanding how to effectively use its validation and sanitization methods may take some time for new users.

  • joi:

    Joi has a steeper learning curve compared to the other libraries, as it requires understanding its schema definition language and validation methods. However, once mastered, it offers powerful capabilities for complex validation scenarios.

Extensibility

  • celebrate:

    Celebrate is built on top of Joi, which means it inherits Joi's extensibility. You can create custom validation rules and extend existing schemas to fit your application's needs, making it a flexible choice for complex validation scenarios.

  • express-joi-validation:

    Express-joi-validation allows you to leverage Joi's extensibility while providing a simple interface for integration with Express. You can easily create custom validators and schemas to meet specific validation requirements in your application.

  • express-validator:

    Express-validator is highly extensible, allowing you to create custom validators and sanitizers. This flexibility makes it suitable for applications with unique validation needs that go beyond the built-in methods.

  • joi:

    Joi is inherently extensible, allowing developers to create custom validation rules and schemas. Its powerful API enables you to define complex validation logic tailored to your application's requirements.

How to Choose: celebrate vs express-joi-validation vs express-validator vs joi

  • celebrate:

    Choose Celebrate if you are already using Joi for schema validation and want a seamless integration with Express.js. It provides a middleware solution that allows you to validate incoming request data against Joi schemas, making it easy to enforce data integrity in your routes.

  • express-joi-validation:

    Select express-joi-validation if you prefer a straightforward way to validate request data using Joi schemas within your Express routes. It offers a simple API for defining validation rules and handling errors, making it suitable for projects where you want to keep validation logic concise and integrated with your routing.

  • express-validator:

    Opt for express-validator if you need a more flexible and feature-rich validation library that supports a wide range of validation and sanitization methods. It allows you to define validation rules directly in your route handlers and provides comprehensive error handling capabilities, making it ideal for applications with complex validation requirements.

  • joi:

    Use Joi if you are looking for a powerful schema description language for JavaScript objects. It is not tied to Express and can be used in various contexts, including standalone validation and integration with other libraries. Joi is particularly useful for defining complex validation rules and data structures.

README for celebrate

celebrate

Current Version Build Status airbnb-style Code Coverage Total Downloads

celebrate is an express middleware function that wraps the joi validation library. This allows you to use this middleware in any single route, or globally, and ensure that all of your inputs are correct before any handler function. The middleware allows you to validate req.params, req.headers, and req.query.

The middleware will also validate:

celebrate lists joi as a formal dependency. This means that celebrate will always use a predictable, known version of joi during the validation and compilation steps. There are two reasons for this:

  1. To ensure that celebrate can always use the latest version of joi as soon as it's published
  2. So that celebrate can export the version of joi it uses to the consumer to maximize compatibility

express Compatibility

celebrate is tested and has full compatibility with express 4 and 5. It likely works correctly with express 3, but including it in the test matrix was more trouble than it's worth. This is primarily because express 3 exposes route parameters as an array rather than an object.

Example Usage

Example of using celebrate on a single POST route to validate req.body.

const express = require('express');
const BodyParser = require('body-parser');
const { celebrate, Joi, errors, Segments } = require('celebrate');

const app = express();
app.use(BodyParser.json());

app.post('/signup', celebrate({
  [Segments.BODY]: Joi.object().keys({
    name: Joi.string().required(),
    age: Joi.number().integer(),
    role: Joi.string().default('admin')
  }),
  [Segments.QUERY]: {
    token: Joi.string().token().required()
  }
}), (req, res) => {
  // At this point, req.body has been validated and 
  // req.body.role is equal to req.body.role if provided in the POST or set to 'admin' by joi
});
app.use(errors());

Example of using celebrate to validate all incoming requests to ensure the token header is present and matches the supplied regular expression.

const express = require('express');
const { celebrate, Joi, errors, Segments } = require('celebrate');
const app = express();

// validate all incoming request headers for the token header
// if missing or not the correct format, respond with an error
app.use(celebrate({
  [Segments.HEADERS]: Joi.object({
    token: Joi.string().required().regex(/abc\d{3}/)
  }).unknown()
}));
app.get('/', (req, res) => { res.send('hello world'); });
app.get('/foo', (req, res) => { res.send('a foo request'); });
app.use(errors());

API

celebrate does not have a default export. The following methods encompass the public API.

celebrate(schema, [joiOptions], [opts])

Returns a function with the middleware signature ((req, res, next)).

  • requestRules - an object where key can be one of the values from Segments and the value is a joi validation schema. Only the keys specified will be validated against the incoming request object. If you omit a key, that part of the req object will not be validated. A schema must contain at least one valid key.
  • [joiOpts] - optional object containing joi options that are passed directly into the validate function. Defaults to { warnings: true }.
  • [opts] - an optional object with the following keys. Defaults to {}.
    • reqContext - bool value that instructs joi to use the incoming req object as the context value during joi validation. If set, this will trump the value of joiOptions.context. This is useful if you want to validate part of the request object against another part of the request object. See the tests for more details.
    • mode - optional Modes for controlling the validation mode celebrate uses. Defaults to partial.

celebrator([opts], [joiOptions], schema)

This is a curried version of celebrate. It is curried with lodash.curryRight so it can be called in all the various fashions that API supports. Returns a function with the middleware signature ((req, res, next)).

  • [opts] - an optional object with the following keys. Defaults to {}.
    • reqContext - bool value that instructs joi to use the incoming req object as the context value during joi validation. If set, this will trump the value of joiOptions.context. This is useful if you want to validate part of the request object against another part of the request object. See the tests for more details.
    • mode - optional Modes for controlling the validation mode celebrate uses. Defaults to partial.
  • [joiOpts] - optional object containing joi options that are passed directly into the validate function. Defaults to { warnings: true }.
  • requestRules - an object where key can be one of the values from Segments and the value is a joi validation schema. Only the keys specified will be validated against the incoming request object. If you omit a key, that part of the req object will not be validated. A schema must contain at least one valid key.
Sample usage

This is an example use of curried celebrate in a real server.

  const express = require('express');
  const { celebrator, Joi, errors, Segments } = require('celebrate');
  const app = express();

  // now every instance of `celebrate` will use these same options so you only
  // need to do it once.
  const celebrate = celebrator({ reqContext: true }, { convert: true });

  // validate all incoming request headers for the token header
  // if missing or not the correct format, respond with an error
  app.use(celebrate({
    [Segments.HEADERS]: Joi.object({
      token: Joi.string().required().regex(/abc\d{3}/)
    }).unknown()
  }));
  app.get('/', celebrate({
    [Segments.HEADERS]: Joi.object({
      name: Joi.string().required()
    })
  }), (req, res) => { res.send('hello world'); });
  app.use(errors());

Here are some examples of other ways to call celebrator

  const opts = { reqContext: true };
  const joiOpts = { convert: true };
  const schema = {
    [Segments.HEADERS]: Joi.object({
      name: Joi.string().required()
    })
  };

  let c = celebrator(opts)(joiOpts)(schema);
  c = celebrator(opts, joiOpts)(schema);
  c = celebrator(opts)(joiOpts, schema);
  c = celebrator(opts, joiOpts, schema);

  // c would function the same in all of these cases.

errors([opts])

Returns a function with the error handler signature ((err, req, res, next)). This should be placed with any other error handling middleware to catch celebrate errors. If the incoming err object is an error originating from celebrate, errors() will respond a pre-build error object. Otherwise, it will call next(err) and will pass the error along and will need to be processed by another error handler.

  • [opts] - an optional object with the following keys
    • statusCode - number that will be used for the response status code in the event of an error. Must be greater than 399 and less than 600. It must also be a number available to the node HTTP module. Defaults to 400.
    • message - string that will be used for the message value sent out by the error handler. Defaults to 'Validation failed'

If the error response format does not suite your needs, you are encouraged to write your own and check isCelebrateError(err) to format celebrate errors to your liking.

Errors origintating from the celebrate() middleware are CelebrateError objects.

Joi

celebrate exports the version of joi it is using internally. For maximum compatibility, you should use this version when creating schemas used with celebrate.

Segments

An enum containing all the segments of req objects that celebrate can validate against.

{
  BODY: 'body',
  COOKIES: 'cookies',
  HEADERS: 'headers',
  PARAMS: 'params',
  QUERY: 'query',
  SIGNEDCOOKIES: 'signedCookies',
}

Modes

An enum containing all the available validation modes that celebrate can support.

  • PARTIAL - ends validation on the first failure. Does not apply joi transformations if any part of the request is invalid.
  • FULL - validates the entire request object and collects all the validation failures in the result. Does not apply joi transformations if any part of the request is invalid.
    • Note: In order for this to work, you will need to pass abortEarly: false to #joiOptions. Or to get the default behavior along with this, { abortEarly: false, warnings: true }

new CelebrateError([message], [opts])

Creates a new CelebrateError object. Extends the built in Error object.

  • message - optional string message. Defaults to 'Validation failed'.
  • [opts] - optional object with the following keys
    • celebrated - bool that, when true, adds Symbol('celebrated'): true to the result object. This indicates this error as originating from celebrate. You'd likely want to set this to true if you want the celebrate error handler to handle errors originating from the format function that you call in user-land code. Defaults to false.

CelebrateError has the following public properties:

  • details - a Map of all validation failures. The key is a Segments and the value is a joi validation error. Adding to details is done via details.set. The value must be a joi validation error or an exception will be thrown.
Sample usage
  const result = Joi.validate(req.params.id, Joi.string().valid('foo'), { abortEarly: false });
  const err = new CelebrateError(undefined, { celebrated: true });
  err.details.set(Segments.PARAMS, result.error);

isCelebrateError(err)

Returns true if the provided err object originated from the celebrate middleware, and false otherwise. Useful if you want to write your own error handler for celebrate errors.

  • err - an error object

Additional Details

Validation Order

celebrate validates request values in the following order:

  1. req.headers
  2. req.params
  3. req.query
  4. req.cookies (assuming cookie-parser is being used)
  5. req.signedCookies (assuming cookie-parser is being used)
  6. req.body (assuming body-parser is being used)

Mutation Warning

If you use any of joi's updating validation APIs (default, rename, etc.) celebrate will override the source value with the changes applied by joi (assuming the request is valid).

For example, if you validate req.query and have a default value in your joi schema, if the incoming req.query is missing a value for default, during validation celebrate will overwrite the original req.query with the result of joi.validate. This is done so that once req has been validated, you can be sure all the inputs are valid and ready to consume in your handler functions and you don't need to re-write all your handlers to look for the query values in res.locals.*.

Additional Info

According the the HTTP spec, GET requests should not include a body in the request payload. For that reason, celebrate does not validate the body on GET requests.

Issues

Before opening issues on this repo, make sure your joi schema is correct and working as you intended. The bulk of this code is just exposing the joi API as express middleware. All of the heavy lifting still happens inside joi. You can go here to verify your joi schema easily.