noNestedPromises

JavaScript (and super languages)

Summary

Rule available since: v2.3.15
Diagnostic Category: lint/suspicious/noNestedPromises
This rule isn’t recommended, so you need to enable it.
This rule doesn’t have a fix.
The default severity of this rule is warning.
Sources:
- Same as promise/no-nesting

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "suspicious": {
5
        "noNestedPromises": "error"
6
      }
7
    }
8
  }
9
}

Description

Disallow nested .then() or .catch() promise calls.

Nesting .then() or .catch() calls defeats the purpose of promises, which is to create a flat chain of asynchronous operations. Nested promise callbacks can make code harder to read and maintain.

However, nesting is allowed when the nested callback references variables from the outer scope, as flattening would break the code in such cases.

Examples

Invalid

1
doThing().then(function() { return a.then() })

code-block.js:1:38 lint/suspicious/noNestedPromises ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Avoid nesting promises.
  
  > 1 │ doThing().then(function() { return a.then() })
      │                                      ^^^^
    2 │ 
  
  ℹ Nesting promises can lead to harder-to-read code because it creates multiple levels of indentation and makes the flow of asynchronous operations less clear.
  
  ℹ Consider refactoring the code to use promise chaining (foo.then().then()) instead of nesting.

1
doThing().then(() => b.catch())

code-block.js:1:24 lint/suspicious/noNestedPromises ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Avoid nesting promises.
  
  > 1 │ doThing().then(() => b.catch())
      │                        ^^^^^
    2 │ 
  
  ℹ Nesting promises can lead to harder-to-read code because it creates multiple levels of indentation and makes the flow of asynchronous operations less clear.
  
  ℹ Consider refactoring the code to use promise chaining (foo.then().then()) instead of nesting.

1
doThing()
2
  .then(a => getB(a)
3
    .then(b => getC(b))
4
  )

code-block.js:3:6 lint/suspicious/noNestedPromises ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Avoid nesting promises.
  
    1 │ doThing()
    2 │   .then(a => getB(a)
  > 3 │     .then(b => getC(b))
      │      ^^^^
    4 │   )
    5 │ 
  
  ℹ Nesting promises can lead to harder-to-read code because it creates multiple levels of indentation and makes the flow of asynchronous operations less clear.
  
  ℹ Consider refactoring the code to use promise chaining (foo.then().then()) instead of nesting.

Valid

1
// Simple returns
2
doThing().then(function() { return 4 })
3
doThing().then(() => 4)

1
// Chained promises (no nesting)
2
doThing()
3
  .then(a => getB(a))
4
  .then(b => getC(b))

1
// Nested but references outer scope variable 'a'
2
doThing()
3
  .then(a => getB(a)
4
    .then(b => getC(a, b))
5
  )

1
// Promise.resolve/all are fine
2
doThing().then(function() { return Promise.all([a,b,c]) })
3
doThing().then(() => Promise.resolve(4))