sindresorhus/ globals

(v13.12.0) about 1 month ago

JavaScript

TypeScript

Need help with globals?

Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

sindresorhus

230 Stars

101 Forks

MIT License

282 Commits

5 Opened issues

Description

Global identifiers from different JavaScript environments

Services available

Need anything else?

Contributors list

Readme

globals

Name: globals
Brand: globals
SKU: //sindresorhus/globals
Rating: 2.325 (230 reviews)

Global identifiers from different JavaScript environments

It's just a JSON file, so use it in any environment.

This package is used by ESLint.

This package no longer accepts new environments. If you need it for ESLint, just create a plugin.

Install

$ npm install globals

Usage

const globals = require('globals');

console.log(globals.browser);
/*
{
    addEventListener: false,
    applicationCache: false,
    ArrayBuffer: false,
    atob: false,
    …
}
*/

Each global is given a value of

true

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#modulesthemodule_scope

When analyzing code that is known to run outside of a CommonJS wrapper, for example, JavaScript modules,

nodeBuiltin

can find accidental CommonJS references.

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}