https://github.com/ljharb/System.global

ECMAScript spec-compliant polyfill/shim for `globalThis`.
https://github.com/ljharb/System.global

Last synced: 2 months ago
JSON representation

ECMAScript spec-compliant polyfill/shim for `globalThis`.

• Host: GitHub
• URL: https://github.com/ljharb/System.global
• Owner: es-shims
• License: mit
• Created: 2016-03-30T05:02:19.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-04-30T02:35:55.000Z (9 months ago)
• Last Synced: 2024-10-30T14:17:34.372Z (2 months ago)
• Language: JavaScript
• Homepage: https://github.com/tc39/proposal-global
• Size: 102 KB
• Stars: 155
• Watchers: 7
• Forks: 14
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ponyfills - globalthis - [`globalThis`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis) (Uncategorised)

README

        
# globalThis [![Version Badge][npm-version-svg]][npm-url]

[![github actions][actions-image]][actions-url]

[![coverage][codecov-image]][codecov-url]

[![dependency status][deps-svg]][deps-url]

[![dev dependency status][dev-deps-svg]][dev-deps-url]

[![License][license-image]][license-url]

[![Downloads][downloads-image]][downloads-url]

[![npm badge][npm-badge-png]][npm-url]

An ECMAScript spec-compliant polyfill/shim for `globalThis`. Invoke its "shim" method to shim `globalThis` if it is unavailable.

This package implements the [es-shim API](https://github.com/es-shims/api) interface. It works in an ES3-supported environment and complies with the [spec proposal](https://github.com/tc39/proposal-global).

Most common usage:

```js

var globalThis = require('globalthis')(); // returns native globalThis if compliant

	/* or */

var globalThis = require('globalthis/polyfill')(); // returns native globalThis if compliant

```

## Example

```js

var assert = require('assert');

// the below function is not CSP-compliant, but reliably gets the

// global object in sloppy mode in every engine.

var getGlobal = Function('return this');

assert.equal(globalThis, getGlobal());

```

```js

/* when `globalThis` is not present */

var shimmedGlobal = require('globalthis').shim();

	/* or */

var shimmedGlobal = require('globalthis/shim')();

assert.equal(shimmedGlobal, globalThis);

assert.equal(shimmedGlobal, getGlobal());

```

```js

/* when `globalThis` is present */

var shimmedGlobal = require('globalthis').shim();

assert.equal(shimmedGlobal, globalThis);

assert.equal(shimmedGlobal, getGlobal());

```

## Tests

Simply clone the repo, `npm install`, and run `npm test`

[npm-url]: https://npmjs.org/package/globalthis

[npm-version-svg]: https://versionbadg.es/ljharb/globalThis.svg

[deps-svg]: https://david-dm.org/ljharb/globalThis.svg?theme=shields.io

[deps-url]: https://david-dm.org/ljharb/globalThis

[dev-deps-svg]: https://david-dm.org/ljharb/globalThis/dev-status.svg?theme=shields.io

[dev-deps-url]: https://david-dm.org/ljharb/globalThis#info=devDependencies

[npm-badge-png]: https://nodei.co/npm/globalthis.png?downloads=true&stars=true

[license-image]: https://img.shields.io/npm/l/globalthis.svg

[license-url]: LICENSE

[downloads-image]: https://img.shields.io/npm/dm/globalthis.svg

[downloads-url]: https://npm-stat.com/charts.html?package=globalthis

[codecov-image]: https://codecov.io/gh/es-shims/globalThis/branch/main/graphs/badge.svg

[codecov-url]: https://app.codecov.io/gh/es-shims/globalThis/

[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/es-shims/globalThis

[actions-url]: https://github.com/es-shims/globalThis/actions