Using Joi, require one of two fields to be non empty

Question

If I have two fields, I'd just like to validate when at least one field is a non empty string, but fail when both fields are empty strings.

Something like this does not validate

var schema = Joi.object().keys({
    a: Joi.string(),
    b: Joi.string()
}).or('a', 'b');

When validating against

{a: 'aa', b: ''}

The or condition only tests for the presence of either key a or b, but does test whether the condition for a or b is true. Joi.string() will fail for empty strings.

Here is gist with some test cases to demonstrate

http://requirebin.com/?gist=84c49d8b81025ce68cfb

score 29 · Accepted Answer · answered Mar 05 '15 at 17:06

Code below worked for me. I used alternatives because .or is really testing for the existence of keys and what you really wanted was an alternative where you would allow one key or the other to be empty.

var console = require("consoleit");
var Joi = require('joi');

var schema = Joi.alternatives().try(
  Joi.object().keys({
    a: Joi.string().allow(''),
    b: Joi.string()
    }),
  Joi.object().keys({
    a: Joi.string(),
    b: Joi.string().allow('')
    })
);

var tests = [
  // both empty - should fail
  {a: '', b: ''},
  // one not empty - should pass but is FAILING
  {a: 'aa', b: ''},
  // both not empty - should pass
  {a: 'aa', b: 'bb'},
  // one not empty, other key missing - should pass
  {a: 'aa'}
];

for(var i = 0; i < tests.length; i++) {
  console.log(i, Joi.validate(tests[i], schema)['error']);
}

This does work, but isn't really scalable - if you had two sets of these, you'd need four alternatives, if you have three set of these then you'd need eight. It doesn't appear that there's a better way though. — El Yobo, May 20 '16 at 07:57

t k · Answer 2 · 2020-06-10T17:19:46.927

12

An alternative way of using Joi.when() that worked for me:

var schema = Joi.object().keys({
  a: Joi.string().allow(''),
  b: Joi.when('a', { is: '', then: Joi.string(), otherwise: Joi.string().allow('') })
}).or('a', 'b')

.or('a', 'b') prevents a AND b being null (as opposed to '').

edited Jun 10 '20 at 17:19

answered Apr 14 '20 at 16:00

t k

387
3
9

2

I have just realised that this will return the message ```"b" is required``` rather than ```either "a" or "b" is required``` but don't know how to fix that. – t k Jun 10 '20 at 16:29
I believe you could use .error to specify your own error message, such as "A value is required for one of the following: (list attributes here)." The problem with scalability seems to remain, however. I have a case where there are 13 attributes and as long as you have a value in one of them, it's valid. I think I'd have to go with "c: Joi.when('a', {is: '', then: Joi.when('b', {is: '', then: Joi.string(), otherwise: Joi.string().allow('')})})" – seekerOfKnowledge May 19 '22 at 19:21

score 2 · Answer 3 · answered Mar 20 '20 at 16:19

If you want to express the dependency between 2 fields without having to repeat all other parts of the object, you could use when:

var schema = Joi.object().keys({
  a: Joi.string().allow(''),
  b: Joi.string().allow('').when('a', { is: '', then: Joi.string() })
}).or('a', 'b');

score 1 · Answer 4 · answered Apr 14 '23 at 21:13

1

You could just use .xor('a', 'b') instead .or('a', 'b'):

var schema = Joi.object().keys({
    a: Joi.string(),
    b: Joi.string()
}).xor('a', 'b');

This allows to be or only a or only b but not both, and not none

if your object is:
{ a: 'non-empty' } or { b: 'non-empty' }
will pass

if your object is:
{ a: '', b: '' } or { a: 'non-empty', b: 'non-empty' } 
will NOT pass

if your object is:
{ a: ''} or { b: '' } 
will NOT pass

if your object is:
{ a: '', b: 'non-empty' } or { a: 'non-empty', b: '' } 
will NOT pass

if your object is:
{ }
will NOT pass

answered Apr 14 '23 at 21:13

Máxima Alekz

572
10
23

Would this support two arrays instead of two strings? For instance I want to prevent two empty arrays – thxmike Aug 01 '23 at 23:38
@thxmike I guess. – Máxima Alekz Aug 29 '23 at 19:33

score 0 · Answer 5 · answered Oct 21 '21 at 18:11

0

the problem I faced with https://stackoverflow.com/a/61212051/15265372 answer is that if both fields are given you won't face any errors, if you want to fix that you need to replace or with xor.

answered Oct 21 '21 at 18:11

Max Shady

68
1
8

Vkeynez Vkey · Answer 6 · 2023-02-09T06:04:23.703

0

&. Simply u can use '.and()'

it will not pass if either one of the fields is empty

var schema = Joi.object().keys({
   a: Joi.string(),
   b: Joi.string()
}).and('a', 'b');````

edited Feb 09 '23 at 06:04

answered Jul 22 '22 at 08:59

Vkeynez Vkey

1
1

Your answer could be improved with additional supporting information. Please [edit] to add further details, such as citations or documentation, so that others can confirm that your answer is correct. You can find more information on how to write good answers [in the help center](/help/how-to-answer). – Community Jul 23 '22 at 18:18

Using Joi, require one of two fields to be non empty

6 Answers6

Linked