https://github.com/tc39/proposal-shadowrealm
ECMAScript Proposal, specs, and reference implementation for Realms
https://github.com/tc39/proposal-shadowrealm
Last synced: 6 days ago
JSON representation
ECMAScript Proposal, specs, and reference implementation for Realms
- Host: GitHub
- URL: https://github.com/tc39/proposal-shadowrealm
- Owner: tc39
- Created: 2016-04-14T15:26:14.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-11-25T13:42:18.000Z (3 months ago)
- Last Synced: 2025-02-08T05:02:03.232Z (14 days ago)
- Language: HTML
- Homepage: https://tc39.es/proposal-shadowrealm/
- Size: 1.36 MB
- Stars: 1,455
- Watchers: 91
- Forks: 67
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ECMAScript spec proposal for ShadowRealm API
- [Explainer](explainer.md).
- [HTML Rendered Spec](https://tc39.es/proposal-shadowrealm/).
- Currently at [Stage 2.7](https://tc39.es/process-document/).
- [Code of Conduct](https://tc39.es/code-of-conduct/)
* @dherman
* @caridy
* @erights
* @leobalter
* @rwaldron
* @legendecas
## Index
* [What are ShadowRealms?](#WhatareRealms)
* [API (TypeScript Format)](#APITypeScriptFormat)
* [Presentations](#Presentations)
* [History](#History)
* [Contributing](#Contributing)
* [Updating the spec text for this proposal](#Updatingthespectextforthisproposal)
ShadowRealms are a distinct global environment, with its own global object containing its own intrinsics and built-ins (standard objects that are not bound to global variables, like the initial value of Object.prototype).
See more at the [explainer](explainer.md) document.
```ts
declare class ShadowRealm {
constructor();
importValue(specifier: string, bindingName: string): Promise;
evaluate(sourceText: string): PrimitiveValueOrCallable;
}
```
See some examples [in the Explainer file](explainer.md).
* [TC39 Meeting, December 2024 - Stage 3 Request](http://ptomato.name/talks/tc39-2024-12/)
* [TC39 Meeting, June 12th 2024 - Stage 2.7 Update](https://docs.google.com/presentation/d/1HxocWS0WfIZPanCAhsabSDOPx9LCjw6upMfMP9ogEqE)
* [TC39 Meeting, February 7th 2024 - Move to Stage 2.7](https://docs.google.com/presentation/d/1fd5-VKtl0LxYitLHr_bJ82_xaLs1w5xSmD0dCdh2TvU)
* [TC39 Meeting, September 7th 2023 - Move to Stage 2](https://docs.google.com/presentation/d/1WJd9g3df_ibVHK3LdoKX2FboDwYQBUBJNxuRAWOYYbM)
* [TC39 Meeting, March 29th 2022 - Stage 3 Update](https://docs.google.com/presentation/d/1Juv36nUTfcvb_E2NUeAPGuToCCBWIX0NLObx_h5qDYU)
* [TC39 Meeting, December 14th 2021 - Stage 3 Update](https://docs.google.com/presentation/d/12PM5c4_yUnqXHjvACh8HEN5oJwgei-0T0hX_hlqjfDU)
* [TC39 Meeting, August 31st 2021 - Rename to ShadowRealm](https://docs.google.com/presentation/d/1Rb6YISQFKNQIANpLctcuk-GGM5InNfcdA0zuUCgb-fE)
* [TC39 Meeting, July 12th 2021 - Stage 3 Request](https://docs.google.com/presentation/d/1MgrUnQH25gDVosKnH10n9n9msvrLkdaHI0taQgOWRcs)
* [TC39 Meeting, May 25th 2021 - Stage 2 Update](https://docs.google.com/presentation/d/1c-7nsjAUkdWYie5n1NlEr7_FxMXHyXjRFzsReLTm8S8)
* [TC39 Meeting, April 2021 - Introduction of Callable Boundary Reealms](https://docs.google.com/presentation/d/1VbfgfZgNCcWhPu-8JWd27hrL9jEfakWPSWPcJLa3SIw)
* [TC39 Meeting, January 2021 - Realms update from Chrome's position on the previous API](https://github.com/tc39/notes/blob/master/meetings/2021-01/jan-26.md#realms-update)
* [TC39 Meeting, November 2020 - Stage 2 Update](https://docs.google.com/presentation/d/1mKdez8FMbJ4QQ2KsOCMXOKVW6QoUnrNQf2cwsLy0MyI)
* [TC39 Meeting, June 4th 2020 - Stage 2 Update](https://docs.google.com/presentation/d/1TfVtfolisUrxAPflzm8wIhBBv_7ij3KLeqkfpdvpFiQ/edit?ts=5ed5d3e7)
* [TC39 Incubator Call May 26th 2020](https://docs.google.com/presentation/d/1FMQB8fu059zSJOtC3uOCbBCYiXAcvHojxzcDjoVQYAo/edit)
* [TC39 Feb 2020 - Stage 2 Update](https://docs.google.com/presentation/d/1umg2Kw18IlQyzrWwaQCAkeZ6xLTGZPPB6MtnI2LFzWE/edit)
* [TC39 May 2018 - Stage 2 Request](https://docs.google.com/presentation/d/1blHLQuB3B2eBpt_FbtLgqhT6Zdwi8YAv6xhxPNA_j0A/edit) (archived)
* we moved on from the exposed globalThis model to a lean isolated realms API (see https://github.com/tc39/proposal-shadowrealm/issues/289 and https://github.com/tc39/proposal-shadowrealm/issues/291)
* we worked on this during ES2015 time frame, so never went through stages process ([ES6 Realm Objects proto-spec.pdf](https://github.com/tc39/proposal-shadowrealm/files/717415/ES6.Realm.Objects.proto-spec.pdf))
* got punted to later (rightly so!)
* original idea from @dherman: [What are Realms?](https://gist.github.com/dherman/7568885)
### Updating the spec text for this proposal
The source for the spec text is located in [spec.html](spec.html) and it is written in
[ecmarkup](https://github.com/bterlson/ecmarkup) language.
When modifying the spec text, you should be able to build the HTML version by using the following command:
```bash
npm install
npm run build
open dist/index.html
```
Alternatively, you can use `npm run watch`.