minimal adjustments
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / @eslint / eslintrc / node_modules / globals / readme.md
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 ## Install
12
13 ```
14 $ npm install globals
15 ```
16
17 ## Usage
18
19 ```js
20 const globals = require('globals');
21
22 console.log(globals.browser);
23 /*
24 {
25         addEventListener: false,
26         applicationCache: false,
27         ArrayBuffer: false,
28         atob: false,
29         …
30 }
31 */
32 ```
33
34 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.
35
36 For Node.js this package provides two sets of globals:
37
38 - `globals.nodeBuiltin`: Globals available to all code running in Node.js.
39         These will usually be available as properties on the `global` object and include `process`, `Buffer`, but not CommonJS arguments like `require`.
40         See: https://nodejs.org/api/globals.html
41 - `globals.node`: A combination of the globals from `nodeBuiltin` plus all CommonJS arguments ("CommonJS module scope").
42         See: https://nodejs.org/api/modules.html#modules_the_module_scope
43
44 When analyzing code that is known to run outside of a CommonJS wrapper, for example, JavaScript modules, `nodeBuiltin` can find accidental CommonJS references.
45
46 ---
47
48 <div align="center">
49         <b>
50                 <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>
51         </b>
52         <br>
53         <sub>
54                 Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
55         </sub>
56 </div>