Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update no-floating-promises lint rule docs page #36913

Merged
merged 3 commits into from
May 14, 2022
Merged

Update no-floating-promises lint rule docs page #36913

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5cec09d
Update no-floating-promises lint rule docs page
JoshuaKGoldberg May 14, 2022
de4d4c9
Whoops, missed the .md
JoshuaKGoldberg May 14, 2022
73a0ee7
Merge branch 'canary' into patch-1
kodiakhq[bot] May 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api-reference/next/router.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,7 @@ export default function MyApp({ Component, pageProps }) {

## Potential ESLint errors

Certain methods accessible on the `router` object return a Promise. If you have the ESLint rule, [no-floating-promises](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-floating-promises.md) enabled, consider disabling it either globally, or for the affected line.
Certain methods accessible on the `router` object return a Promise. If you have the ESLint rule, [no-floating-promises](https://typescript-eslint.io/rules/no-floating-promises) enabled, consider disabling it either globally, or for the affected line.

If your application needs this rule, you should either `void` the promise – or use an `async` function, `await` the Promise, then void the function call. **This is not applicable when the method is called from inside an `onClick` handler**.

Expand Down