Maaz Zindani

Loading the index…

↑↓ move↵ openesc close4072 pages
Next.js and React

Yup conditional validation throws branch is not a function

ErrorTypeError: branch is not a function

Short answer

In Yup 1.x, the object form of when() needs then and otherwise to be functions that take the schema and return a schema. If you pass a schema directly, as Yup 0.32 allowed, Yup tries to call it and fails with 'branch is not a function'. Wrap each branch as (schema) => schema.something().

  • Applies to Yup 1.x, React 19, Formik 2
  • Updated
  • By Maaz Zindani, Senior Software Engineer

Fix it fast

  1. 1Find out which cause you have

    Find every when() call in the project and see what is passed as then and otherwise. A schema object there is the problem.

    grep -rn "then:" src/ | grep -i "yup\|string()\|number()\|boolean()"
    npm ls yup
  2. 2Match what you see, then jump to its fix

    1. 1TypeError: branch is not a function at Condition.fn, only on forms that use when()then or otherwise is a schema, not a functionFix
    2. 2No crash, but the condition never matches, or the function returns something that is not a schemaThe function form still uses the old argument styleFix

What does the error look like?

  • TypeError: branch is not a function
  • at Condition.fn

Cause 1 of 2

then or otherwise is a schema, not a function

1Check

Look for a then or otherwise value that is a schema such as yup.string().required(). That style belongs to Yup before 1.0.

// old style, fails on Yup 1.x
password: yup.string().when('mode', {
  is: 'signup',
  then: yup.string().required(),
})

2Fix

Change each branch to a function that receives the current schema and returns a schema. The Yup changelog lists this as a breaking change of 1.0.

password: yup.string().when('mode', {
  is: 'signup',
  then: (schema) => schema.required('Password is required'),
  otherwise: (schema) => schema.notRequired(),
})

3Verify

Validate once with the condition true and once with it false. The first should report the error, the second should pass.

await schema.validate({ mode: 'signup', password: '' }).catch((e) => console.log(e.message));
await schema.validate({ mode: 'login', password: '' });

Confirmed by github.com

Did this fix it?

Cause 2 of 2

The function form still uses the old argument style

1Check

In 1.x the function form of when() receives the dependent values as an array, then the schema. Code written as (value, schema) reads the whole array as the value, and every function must return a schema.

// old style
age: yup.number().when('isAdult', function (isAdult, schema) {
  return isAdult ? schema.min(18) : schema;
})

2Fix

Destructure the array in the first argument, use the schema argument rather than this, and always return a schema.

age: yup.number().when('isAdult', ([isAdult], schema) => {
  return isAdult ? schema.min(18) : schema.min(0);
})

3Verify

Run the schema against a value that should fail under the condition.

await schema.validate({ isAdult: true, age: 10 }).catch((e) => console.log(e.message));

Confirmed by github.com

Did this fix it?

How do I stop it coming back?

  • Pin the Yup major version in package.json and read the changelog before you upgrade it.
  • Write when() with the function form for then and otherwise from the start.
  • Add one unit test per condition so a changed API fails in CI and not in the browser.

Sources

How was this page made?

I drafted this page with AI assistance from the official documents listed under Sources. Every cause above names the document that confirms it. I have not reproduced this fix on a machine of my own yet, so read it as documented guidance, not a test report. Found a mistake? Tell me.

Which stack is behind this page?

Projects of mine built on the same technologies:

Related fixes

Next step

Want this handled for good?

I look after servers, apps and releases end to end. Tell me what keeps breaking.