usePromiseRejectErrors (JavaScript)

Language JavaScript (and super languages)

Summary

Diagnostic Category: lint/nursery/usePromiseRejectErrors
This rule doesn’t have a fix.
The default severity of this rule is warning.
Sources:
- Same as prefer-promise-reject-errors

How to configure

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

Description

Require Error objects as Promise rejection reasons.

Error objects capture a stack trace that helps locate the cause of a rejection. Rejecting with a string or another non-Error value loses this information.

This rule checks Promise.reject() and calls to the second parameter of a new Promise() executor. Values that could be errors, such as function calls and unknown variables, are allowed without inspecting their types.

Examples

Invalid

1
Promise.reject("Request failed");

code-block.js:1:1 lint/nursery/usePromiseRejectErrors ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ This Promise rejection reason is not an Error object.
  
  > 1 │ Promise.reject("Request failed");
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Error objects capture a stack trace that helps locate the cause of a rejection.
  
  ℹ Pass an Error object to preserve debugging information.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.

1
new Promise((resolve, reject) => reject(42));

code-block.js:1:34 lint/nursery/usePromiseRejectErrors ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ This Promise rejection reason is not an Error object.
  
  > 1 │ new Promise((resolve, reject) => reject(42));
      │                                  ^^^^^^^^^^
    2 │ 
  
  ℹ Error objects capture a stack trace that helps locate the cause of a rejection.
  
  ℹ Pass an Error object to preserve debugging information.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.

1
Promise.reject();

code-block.js:1:1 lint/nursery/usePromiseRejectErrors ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ This Promise rejection reason is not an Error object.
  
  > 1 │ Promise.reject();
      │ ^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Error objects capture a stack trace that helps locate the cause of a rejection.
  
  ℹ Pass an Error object to preserve debugging information.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.

Valid

1
Promise.reject(new Error("Request failed"));
2
new Promise((resolve, reject) => reject(new TypeError("Invalid value")));
3
Promise.reject(getError());