https://github.com/sindresorhus/globals

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

Last synced: 2 months 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 (over 10 years ago)
• Default Branch: main
• Last Pushed: 2024-03-26T04:42:24.000Z (3 months ago)
• Last Synced: 2024-04-15T13:59:10.975Z (2 months ago)
• Language: JavaScript
• Size: 351 KB
• Stars: 334
• Watchers: 11
• Forks: 107
• Open Issues: 13
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Security: .github/security.md

Lists

• awesome-eslint - ES and browser globals
• awesome-github-star - globals
• awesome-stars - sindresorhus/globals - Global identifiers from different JavaScript environments (JavaScript)

README

        
# globals

> Global identifiers from different JavaScript environments

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

This package is used by ESLint.

**This package [no longer accepts](https://github.com/sindresorhus/globals/issues/82) new environments. If you need it for ESLint, just [create a plugin](http://eslint.org/docs/developer-guide/working-with-plugins#environments-in-plugins).**

## Install

```sh

npm install globals

```

## Usage

```js

const globals = require('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 `global` 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.