Understanding no-floating-promises

[GZLiew]

Body

Hi I added the @typescript-eslint/no-floating-promises rule to my code base but why does the following code not error ?

    '@typescript-eslint/no-floating-promises': 'error',

export const sleep = (ms = 3000) =>
  new Promise((resolve) => setTimeout(resolve, ms));

const a =  sleep();

but calling only sleep() errors

    sleep(); // Promises must be awaited

Additional Info

No response

Before you submit your discussion, please confirm the following. If any of these required steps are not taken, we may not be able to review your RFC. Help us to help you!

• I have read the discussions guidelines and per those guidelines, this fits a discussion category, not a help request or standard issue.
• I have searched for related discussions and searched for related issues and found none that match my proposal.
• I have read the FAQ and my problem is not listed.

[bradzacher]

The rule assumes your variable will be used and handled appropriately.
Unused variables can be caught using the no-unused-vars rule.

[JoshuaKGoldberg]

Looks like this was a straightforward resolution 🙂. Thanks all!

Filed #8088 to improve docs around this.