prefer-global-this should allow window.setTimeout() and setInterval()

[n0099]

Description

as it's a common workaround: 1, 2, for globalThis.setTimeout() and setInterval() returning NodeJS.Timeout in @types/node

Fail

const id: number = window.setTimeout(console.log, 100);
//                 ^^^^^^
// Prefer `globalThis` over `window`. eslint(unicorn/prefer-global-this)

Pass

const id: number = window.setTimeout(console.log, 100);

const id: NodeJS.Timeout | number = globalThis.setTimeout(console.log, 100);

Additional Info

No response

[sindresorhus]

I disagree. The correct way to handle it is:

const id: ReturnType<typeof setTimeout> = window.setTimeout(console.log, 100);

[fregante]

I had this exact issue yesterday 😅

I wish there was a way to instruct the user on how to proceed in cases like this. Should this specific scenario be handled differently? For example:

• disable auto-fix in TS files
• extend the message to specify how to specify the type
• mention it in the rule's readme

I also had issues regarding globalThis types after running this rule. "Nobody knows" how to make globals available as properties on globalThis (the solution seems to be declare var someGlobal: Type, see xojs/eslint-config-xo-typescript#91)

[n0099]

In my scenario I'm storing the id returned by setTimeout() for latter cancelation via clearTimeout().
If I have to make it compatible with both node and browser enviornment, the initial value of id before its first assign from setTimeout() should be conditionally set to:

let id = import.meta.client ? 0 : import.meta.server ? new NodeJS.Timeout() : ...;

for preventing let TDZ and a violation of eslint rule init-declarations.
Or with the fact that clearTimeout() accepts undefined on both node and browser:

let id: ReturnType<typeof setTimeout> | undefined = undefined;

but this will also violates the eslint rule no-undef-init and unicorn/no-useless-undefined.

[fregante]

You don't need any of that. Just call setTimeout normally.

As for the let, the lint rule is right. This is correct:

let id: ReturnType<typeof setTimeout> | undefined;

// and then

id = setTimeout()
clearTimeout(id)