sindresorhus/eslint-plugin-unicorn

`prefer-top-level-await`: Do not report cases where the promise is assigned to a variable

Closed

#2,516 opened on Dec 24, 2024

 (3 comments) (2 reactions) (0 assignees)JavaScript (468 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (5,022 stars)
PR merge metrics
 (Avg merge 1d 16h) (399 merged PRs in 30d)

Description

Description

Hello 👋, thank you for this great plugin :)

I have a case where I create a Promise on the top-level and assign it to a variable. Later, in an asynchronous function, I await the promise:

const preparationDone = prepareSomething();

export async function doSomethingThatNeedsPerparation() {
	await preparationDone;
	// ...
}

The motivation behind this is as follows: I don't want to use top-level await because I don't want to slow down the evaluation of the module scope. The result of the Promise must only be available at the time when the asynchronous function is executed.

Would it therefore be possible not to report cases in which the Promise is assigned to a variable?

Fail

run().catch(error => {
	console.error(error);
	process.exit(1);
});

Pass

const resultOfRun = run();

Additional Info

I know that the rule might be "too relaxed" in that case, but I still think that my use case is valid and should not reported as an anti-pattern :)

Contributor guide