57 lines
2.4 KiB
Markdown
57 lines
2.4 KiB
Markdown
|
# globals [](https://travis-ci.org/sindresorhus/globals)
|
||
|
|
|
||
|
|
> Global identifiers from different JavaScript environments
|
||
|
|
|
||
|
|
Extracted from [JSHint](https://github.com/jshint/jshint/blob/3a8efa979dbb157bfb5c10b5826603a55a33b9ad/src/vars.js) and [ESLint](https://github.com/eslint/eslint/blob/b648406218f8a2d7302b98f5565e23199f44eb31/conf/environments.json) and merged.
|
||
|
|
|
||
|
|
It's just a [JSON file](globals.json), so use it in whatever environment you like.
|
||
|
|
|
||
|
|
**This module [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
|
||
|
|
|
||
|
|
```
|
||
|
|
$ 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.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
<div align="center">
|
||
|
|
<b>
|
||
|
|
<a href="https://tidelift.com/subscription/pkg/npm-globals?utm_source=npm-globals&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
||
|
|
</b>
|
||
|
|
<br>
|
||
|
|
<sub>
|
||
|
|
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
||
|
|
</sub>
|
||
|
|
</div>
|