Allow optional parameters in Joi without specifying them

Question

I'm fairly new to using Joi to validate request payloads in hapi. My question is the following. I have this defined route:

{
    method: 'POST',
    path: '/foo/bar',
    config: {
      description: 'foo.bar',
      handler: handlers.foo,
      auth:false,
      tags: ['api'],
      validate: {
        payload: {
          email : Joi.string().required(),
          password : Joi.string().required(),
        }
      }
    }
}

Email and password are my required properties. However, i would like to allow other properties without having to specify them all. for example:

{
  email: foo@bar.com,
  password: fooPass,
  name: myName,
  surname: mySurname
}

Is there a way to do it with Joi?

score 31 · Accepted Answer · answered Nov 04 '15 at 02:28

31

You can set allowUnknown to true in options:

validate: {
  payload: {
    email : Joi.string().required(),
    password : Joi.string().required(),
  },
  options: {
    allowUnknown: true
  }
}

The options parameter is passed to Joi on validation.

answered Nov 04 '15 at 02:28

Gergo Erdosi

40,904
21
118
94

score 5 · Answer 2 · answered Jul 22 '19 at 14:44

5

For current version of Joi (v15.1.0), while doing

Joi.validate(value, schema, options)

set allowUnknown: true

into the options object.

Reference:

https://github.com/hapijs/joi/blob/v15.1.0/API.md#validatevalue-schema-options-callback

answered Jul 22 '19 at 14:44

harkirat1892

453
5
19

Allow optional parameters in Joi without specifying them

2 Answers2