noMisusedPromises

Ce contenu n’est pas encore disponible dans votre langue.

TypeScript and TSX

Summary

Rule available since: v2.1.0
Diagnostic Category: lint/nursery/noMisusedPromises
This rule has an unsafe fix.
The default severity of this rule is information.
This rule belongs to the following domains:
- project
Sources:
- Same as @typescript-eslint/no-misused-promises

Description

Disallow Promises to be used in places where they are almost certainly a mistake.

In most cases, if you assign a Promise somewhere a Promise is not allowed, the TypeScript compiler will be able to catch such a mistake. But there are a few places where TypeScript allows them — they’re not necessarily a mistake — even though they could be considered almost certainly to be one.

This rule disallows using Promises in such places.

Examples

Invalid

1
const promise = Promise.resolve('value');
2
if (promise) { /* This branch will always execute */ }

1
const promise = Promise.resolve('value');
2
const val = promise ? 123 : 456; // Always evaluates to `123`.

1
// The following filter has no effect:
2
const promise = Promise.resolve('value');
3
[1, 2, 3].filter(() => promise);

1
const promise = Promise.resolve('value');
2
while (promise) { /* This is an endless loop */ }

1
// Using a `Promise` as an iterable expands to nothing:
2
const getData = () => fetch('/');
3
console.log({ foo: 42, ...getData() });

1
// These `fetch`-es are not `await`-ed in order:
2
[1, 2, 3].forEach(async value => {
3
    await fetch(`/${value}`);
4
});

Valid

1
const promise = Promise.resolve('value');
2
if (await promise) { /* Do something */ }
3

4
const val = (await promise) ? 123 : 456;
5

6
while (await promise) { /* Do something */ }
7

8
const getData = () => fetch('/');
9
console.log({ foo: 42, ...(await getData()) });
10

11
// for-of puts `await` in outer context:
12
for (const value of [1, 2, 3]) {
13
    await doSomething(value);
14
}

How to configure

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