1 | # globals [![Build Status](https://travis-ci.org/sindresorhus/globals.svg?branch=master)](https://travis-ci.org/sindresorhus/globals)
|
2 |
|
3 | > Global identifiers from different JavaScript environments
|
4 |
|
5 | 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.
|
6 |
|
7 | It's just a [JSON file](globals.json), so use it in whatever environment you like.
|
8 |
|
9 | **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).**
|
10 |
|
11 |
|
12 | ## Install
|
13 |
|
14 | ```
|
15 | $ npm install globals
|
16 | ```
|
17 |
|
18 |
|
19 | ## Usage
|
20 |
|
21 | ```js
|
22 | const globals = require('globals');
|
23 |
|
24 | console.log(globals.browser);
|
25 | /*
|
26 | {
|
27 | addEventListener: false,
|
28 | applicationCache: false,
|
29 | ArrayBuffer: false,
|
30 | atob: false,
|
31 | ...
|
32 | }
|
33 | */
|
34 | ```
|
35 |
|
36 | 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.
|
37 |
|
38 |
|
39 | ## License
|
40 |
|
41 | MIT © [Sindre Sorhus](https://sindresorhus.com)
|