https://github.com/sindresorhus/globals

Global identifiers from different JavaScript environments
https://github.com/sindresorhus/globals

Last synced: about 1 month ago
JSON representation

Global identifiers from different JavaScript environments

• Host: GitHub
• URL: https://github.com/sindresorhus/globals
• Owner: sindresorhus
• License: mit
• Created: 2013-12-14T13:46:23.000Z (almost 11 years ago)
• Default Branch: main
• Last Pushed: 2024-04-28T08:21:38.000Z (6 months ago)
• Last Synced: 2024-05-01T12:46:07.473Z (6 months ago)
• Language: JavaScript
• Size: 364 KB
• Stars: 342
• Watchers: 11
• Forks: 108
• Open Issues: 12
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome-github-star - globals
• awesome-eslint - ES and browser globals

README

        
# globals

> Global identifiers from different JavaScript environments

It's just a [JSON file](globals.json), so you can use it in any environment.

This package is used by ESLint 8 and earlier. For ESLint 9 and later, you should depend on this package directly in [your ESLint config](https://eslint.org/docs/latest/use/configure/language-options#predefined-global-variables).

## Install

```sh

npm install globals

```

## Usage

```js

import globals from 'globals';

console.log(globals.browser);

/*

{

	addEventListener: false,

	applicationCache: false,

	ArrayBuffer: false,

	atob: false,

	…

}

*/

```

Each global is given a value of `true` or `false`. A value of `true` indicates that the variable may be overwritten. A value of `false` indicates that the variable should be considered read-only. This information is used by static analysis tools to flag incorrect behavior. We assume all variables should be `false` unless we hear otherwise.

For Node.js this package provides two sets of globals:

- `globals.nodeBuiltin`: Globals available to all code running in Node.js.

	These will usually be available as properties on the `globalThis` object and include `process`, `Buffer`, but not CommonJS arguments like `require`.

	See: https://nodejs.org/api/globals.html

- `globals.node`: A combination of the globals from `nodeBuiltin` plus all CommonJS arguments ("CommonJS module scope").

	See: https://nodejs.org/api/modules.html#modules_the_module_scope

When analyzing code that is known to run outside of a CommonJS wrapper, for example, JavaScript modules, `nodeBuiltin` can find accidental CommonJS references.