Joi for JavaScript (Node.js): Complete Guide with Examples

Introduction to Joi: What It Is and Why You Need It

\n\n

Joi is a powerful data validation library for the JavaScript (Node.js) environment. It allows you to describe data schemas using a simple and expressive API, and then check whether real objects conform to these schemas. Joi is especially popular when developing the server side of web applications, where it is necessary to validate incoming requests, configurations, form data, and any other data structures.

\n\n

Main reasons to use Joi:

\n

\n
• Security: prevents invalid or malicious data from entering your application
\n
• Code readability: Joi schemas are easy to read and understand
\n
• Flexibility: supports complex nested structures, conditional validation, and custom rules
\n
• Integration: works great with Express, Koa, Fastify, and other frameworks
\n
• Detailed errors: provides clear error messages indicating the exact location of the problem
\n

\n\n

Installing Joi

\n\n

Installing Joi in a Node.js project is done via npm or yarn:

\n\n

# Via npm\nnpm install joi\n\n# Via yarn\nyarn add joi\n\n# If you are using TypeScript, install the types (optional)\nnpm install @types/joi --save-dev

\n\n

After installation, you can import Joi into your project:

\n\n

const Joi = require('joi');\n// or for ES modules:\n// import Joi from 'joi';

\n\n

Quick Start: First Validation Example

\n\n

Let's create a simple schema for validating user data and test it:

\n\n

const Joi = require('joi');\n\n// Define the validation schema\nconst schema = Joi.object({\n    username: Joi.string()\n        .alphanum()\n        .min(3)\n        .max(30)\n        .required(),\n    password: Joi.string()\n        .pattern(new RegExp('^[a-zA-Z0-9]{3,30}$')),\n    email: Joi.string()\n        .email({ minDomainSegments: 2, tlds: { allow: ['com', 'net'] } })\n});\n\n// Data to validate\nconst userData = {\n    username: 'john_doe',\n    password: 'myPassword123',\n    email: 'john@example.com'\n};\n\n// Perform validation\nconst { error, value } = schema.validate(userData);\n\nif (error) {\n    console.log('Validation error:', error.details);\n} else {\n    console.log('Data is valid:', value);\n}

\n\n

In this example, we created a schema for an object with three fields. The validate() method returns an object with two properties: error (if there are errors) and value (the validated data).

\n\n

Main Joi Methods

\n\n

1. Joi.string() — String Validation

\n

What it does: Creates a validator for string values. Provides many methods for checking length, format, content, and other string characteristics.

\n\n

Parameters: No parameters. Returns a validator object to which you can apply a chain of methods.

\n\n

Example:

\n

const schema = Joi.string()\n    .min(3)           // minimum length of 3 characters\n    .max(10)          // maximum length of 10 characters\n    .alphanum()       // only letters and numbers\n    .required();      // required field\n\nconsole.log(schema.validate('Hello'));    // { value: 'Hello' }\nconsole.log(schema.validate('Hi'));       // { error: ... } - string too short\nconsole.log(schema.validate('Hello123')); // { value: 'Hello123' }\nconsole.log(schema.validate('Hello!'));   // { error: ... } - contains special characters

\n\n

2. Joi.number() — Number Validation

\n

What it does: Creates a validator for numeric values. Allows checking range, integer status, positivity, and other number properties.

\n\n

Parameters: No parameters. Supports a chain of methods for configuration.

\n\n

Example:

\n

                
    

  
Also in library
  

                
                  
                 Authorization and Authentication in Go: Packages and Practical Examples
      
                
                  
                 lo for Go: Complete Guide with Examples
      
                
                  
                 inversify for TypeScript: Complete Guide with Examples
      
                
                  
                 ORM for PHP: Comparison of Doctrine, Eloquent, and Cycle — Code Examples
      
                
                  
                 Sending Email in C# (.NET) Using SmtpClient and MailKit