Validate array of objects in express validator

Question

I am using express validator to validate my fields. But now i have array of 2 or 3 objects, which contains the "userId" and "Hours" fields like below.

[
  {
    user_id:1,
    hours:8
  },
  {
    user_id:2,
    hours:7
  }
]

Now i need to validate, if any of object property like hours or user_id is empty or not.if empty throw it's error.

While you are at it, I would recommend taking a look at `Joi` for validations. It makes validation of such cases very easy. Joi docs => https://github.com/hapijs/joi/blob/v14.3.0/API.md — Anand Undavia, Nov 29 '18 at 11:50
what is this? I want to validate using express validator only. — , Nov 29 '18 at 11:57

score 58 · Answer 1 · edited Aug 30 '21 at 20:08

58

let arr = [
  {
    user_id:1,
    hours:8
  },
  {
    user_id:2,
    hours:7
  }
]

You can put check like this, note that arr would be the key in the request body. :

check("arr.*.user_id")  
  .not()  
  .isEmpty()

check("arr.*.hours")  
  .not()  
  .isEmpty()

edited Aug 30 '21 at 20:08

Kasir Barati

606
13
24

answered Dec 11 '18 at 17:17

Nikhil Prabhakar

699
5
7

What is the `arr`? is it the key name in the request body? – Kasir Barati Aug 17 '21 at 12:44
1

@KasirBarati yes. You can see the documentation for Wildcards [here](https://express-validator.github.io/docs/wildcards.html) – Rafael Tavares Aug 18 '21 at 15:27

Navid Barsalari · Answer 2 · 2020-06-15T05:35:16.093

I was able to do it with wildcards like this:

app.post('/users', [
    body().isArray(),
    body('*.user_id', 'user_idfield must be a number').isNumeric(),
    body('*.hours', 'annotations field must a number').exists().isNumeric(),
], (req, res) => {
  const errors = validationResult(req);
  if (!errors.isEmpty()) {
      return res.status(422).json({errors: errors.array()});
  }
 return res.status(200).json(req.body)

Lucio Mollinedo · Answer 3 · 2022-04-07T02:30:09.923

For anyone who wants to validate an array of objects using checkSchema, here's an example where I am validating an array of objects which can have 0 items. You could even do custom validation if you throw a function to do so:

JSON:

{
    "employees": [
        {
            "roleId": 3,
            "employeeId": 2,
        },
        {
            "roleId": 5,
            "employeeId": 4,
        },
    ]
}

checkSchema:

const customValidator = (async (employees, { req }) => {
    // employees will always be an array, 
    // given the bail property that will make 
    // the code to never reach the custom validator 
    // if the isArray validator fails

    if(!something) {
        throw Error('employee error');
    }

    // validate at your will here. 

    return true;    
}
checkSchema({
    employees: {
        isArray: {
            bail:true,
            options: {
              min: 0,
            },
        },
        custom: {
            options: customValidator
        },
    },
    "employees.*.roleId": {
        isInt: true
    },
    "employees.*.employeeId": {
        isInt: true
    }
})

In your example, the customValidator will run before the "employees.*.roleId" and "employees.*.employeeId" validators. If the customValidator needs to use these fields, do you expect it to implement its own validation on roleId and employeeId? — katboo, Oct 04 '22 at 16:35

score 5 · Answer 4 · answered Mar 04 '20 at 12:31

5

You achieve this by accessing the request body:

const { body } = require('express-validator')

body('*.*')
  .notEmpty()

answered Mar 04 '20 at 12:31

Thyago Dias

161
2
4

score 1 · Answer 5 · answered Oct 20 '21 at 13:03

If you gonna validate the whole body and the body is an array of objects, you may do this by creating middleware chain with validator(1), errors check(2) and useful middleware(2).

    import { body, validationResult } from "express-validator";
    // we will use lodash method like an example
    import { isArray } from "lodash";
    
    app.post(
        "/users",
        // the second argument "meta" contains whole request and body
        body().custom((_unused, meta) => myCustomValidator(meta.req.body)), // (1)
        ensureNoErrors, // (2)
        doUsefulStuff // (3)
    );

Actually that's all: you need to use construction (1) for getting result.

In order to clarify methods implementation:

    function myCustomValidator(body) {
        if (isArray(body)) {
            throw new Error("Body must be an array");
        }
        // do other checks with the whole body, throw error if something is wrong
        return true;
    }
    
    function ensureNoErrors(req, res, next) {
        // check if validation result contains errors and if so return 400
        const errors = validationResult(req);
        if (errors.isEmpty()) {
            return next();
        }
        return res.status(400).json({
            // return message of the first error like an example
            error: errors.array()[0].msg,
        });
    }
    
    function doUsefulStuff(req, res, next) {
        // do some useful stuff with payload
        const [user1, user2] = req.body;
    }

Link to express-validator documentation.

Validate array of objects in express validator

5 Answers5