useGlobalThis

JavaScript (and super languages)

Summary

Rule available since: v2.3.14
Diagnostic Category: lint/style/useGlobalThis
This rule isn’t recommended, so you need to enable it.
This rule doesn’t have a fix.
The default severity of this rule is warning.
Sources:
- Same as unicorn/prefer-global-this

How to configure

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

Description

Enforce the use of globalThis over window, self, and global.

globalThis is a standard way to access the global object across platforms such as browsers, Web Workers, Node.js and so on, and using it can make your code portable.

However, there are several exceptions that are allowed:

Certain window/Web Workers-specific APIs, such as window.innerHeight and self.postMessage
Window-specific events, such as window.addEventListener('resize')

Examples

Invalid

1
window.foo;

code-block.js:1:1 lint/style/useGlobalThis ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Prefer globalThis over window, self and global.
  
  > 1 │ window.foo;
      │ ^^^^^^
    2 │ 
  
  ℹ globalThis is the standard way to access the global object across environments, which improves code portability.

1
window.addEventListener('click', () => {});

code-block.js:1:1 lint/style/useGlobalThis ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Prefer globalThis over window, self and global.
  
  > 1 │ window.addEventListener(‘click’, () => {});
      │ ^^^^^^
    2 │ 
  
  ℹ globalThis is the standard way to access the global object across environments, which improves code portability.

Valid

1
globalThis.foo;

1
globalThis.addEventListener('click', () => {});

1
// window/Web Workers-specific APIs are allowed
2
window.innerWidth;
3
self.postMessage({ type: 'ready' });

1
// window-specific events are allowed
2
window.addEventListener('resize', () => {});