How to validate string length with Mongoose?

In Mongoose, you can validate string length by setting the minlength and maxlength properties within the model definition. Mongoose provides these built-in validators to ensure data satisfies specific criteria before being saved to the MongoDB database. This approach helps maintain data consistency and quality.

Example

Consider creating a user model with a username field that must be between 3 and 30 characters. Below is an example of defining this field in a Mongoose model:

javascript
const mongoose = require('mongoose');
const Schema = mongoose.Schema;

const userSchema = new Schema({
    username: {
      type: String,
      required: true,
      minlength: 3,
      maxlength: 30
    },
    // Add other fields
});

const User = mongoose.model('User', userSchema);

const newUser = new User({
    username: 'Li'
});

newUser.save((err) => {
    if (err) {
        console.log('Error:', err.message);
        // Output error message, e.g., "username: Path `username` (`Li`) is shorter than the minimum allowed length (3)."
    } else {
        console.log('New user saved successfully!');
    }
});

In this example, if the username field's length violates the constraints, Mongoose will raise a validation error and prevent saving the data to the database. This enables client-side validation, minimizing the backend's handling of invalid data.

Advanced Validation

In addition to basic minlength and maxlength validation, Mongoose supports custom validators. For complex string validation, such as verifying a string against a specific format, you can use custom validators.

javascript
userSchema.path('username').validate((value) => {
    // Add custom logic, e.g., regex validation
    return value.length >= 3 && RegExp('^[a-zA-Z0-9]+$').test(value);
}, 'Invalid username');

const anotherUser = new User({
    username: 'Tom!'
});

anotherUser.save((err) => {
    if (err) {
        console.log('Error:', err.message);
        // Output error message, e.g., "Invalid username"
    } else {
        console.log('Another user saved successfully!');
    }
});

This custom validator checks both the length and ensures the username consists solely of letters and numbers.