You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

36 lines
1.3 KiB

5 years ago
  1. # globals [![Build Status](https://travis-ci.org/sindresorhus/globals.svg?branch=master)](https://travis-ci.org/sindresorhus/globals)
  2. > Global identifiers from different JavaScript environments
  3. 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.
  4. It's just a [JSON file](globals.json), so use it in whatever environment you like.
  5. **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).**
  6. ## Install
  7. ```
  8. $ npm install globals
  9. ```
  10. ## Usage
  11. ```js
  12. const globals = require('globals');
  13. console.log(globals.browser);
  14. /*
  15. {
  16. addEventListener: false,
  17. applicationCache: false,
  18. ArrayBuffer: false,
  19. atob: false,
  20. ...
  21. }
  22. */
  23. ```
  24. 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.