shadowrealm-api - GitLite

KO | EN

gitlite — search

#javascript #python #ai #golang #android #machine-learning #rust #docker #nodejs #kubernetes #pytorch #security #ios #mcp

shadowrealm-api

(★ 136)

🗳️ A implementation of the ShadowRealm API Proposal, a JavaScript sandbox, test with TC39 Test262 cases.

File Explorer

Download Latest Version (.zip)

- settings.json
- - index.1db60ffe.css
  - index.ff870cb1.js
- .nojekyll
- index.html
- - .nojekyll
- index.css
- index.html
- index.ts
- tsconfig.json
- vite.config.ts
- build.mjs
- - helpers.ts
  - index.ts
- helpers.ts
- index.ts
- polyfill.ts
- RealmRecord.ts
- ShadowRealm.ts
- type.ts
- - constructor.js
  - descriptor.js
  - extensibility.js
  - global-object.js
  - instance-extensibility.js
  - instance.js
  - length.js
  - name.js
  - proto.js
- helpers.js
- test262
- transformer.js
.gitignore
.gitmodules
.npmignore
.prettierignore
.prettierrc.js
LICENSE
package-lock.json
package.json
README.md
README.zh-CN.md
tsconfig.json

# Installation Guide

1. Get the code

git clone https://github.com/ambit-tsai/shadowrealm-api

Downloads the entire project code from GitHub to your computer.

cd shadowrealm-api

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm i -S shadowrealm-api

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ShadowRealm API Polyfill
A implementation of the <a href="https://tc39.es/proposal-shadowrealm" target="_blank">ShadowRealm API Proposal</a>, a JavaScript sandbox, test with <a href="https://github.com/tc39/test262/tree/main/test/built-ins/ShadowRealm" target="_blank">TC39 Test262</a> cases.

[简体中文](https://gitee.com/ambit/shadowrealm-api) | English
```ts
declare class ShadowRealm {
    constructor();
    evaluate(sourceText: string): Primitive | Function;
    importValue(specifier: string, bindingName: string): Promise<Primitive | Function>;
}
```
<a href="https://ambit-tsai.github.io/shadowrealm-api/" target="_blank">Try it now 🎉</a>

## Install
```
npm i -S shadowrealm-api
```

## Usage
### Po**n**yfill: non-invasive
```javascript
import ShadowRealm from 'shadowrealm-api'

const realm = new ShadowRealm();
```

### Po**l**yfill: patch up the global object
```javascript
import 'shadowrealm-api/dist/polyfill'

const realm = new ShadowRealm();
```

## Debugging
Print internal info for debugging
```js
ShadowRealm.__debug = true;
```

## Limitations
1. All code evaluated inside a ShadowRealm runs in **strict mode**;
2. The ESM statement must not contain redundant comments;
```js
// ❌
import/* */defaultExport from "module-name";
export default/* */'xxx';

// ✅
import defaultExport from "module-name";
export default 'xxx';
```
3. Exporting variable declarations is not supported;
```js
// ❌
export const obj = {...}, fn = () => {...};

// ✅
const obj = {...}, fn = () => {...};
export { obj, fn };
```

## Compatibility
|IE|Edge|Firefox|Chrome|Safari|Opera|
|:-:|:-:|:-:|:-:|:-:|:-:|
||14|29<sup>[1][2]</sup>|32<sup>[1][2]</sup>|8<sup>[2][3]</sup>|19<sup>[1][2]</sup>|
|||41|49|10.1<sup>[3]</sup>|36|
|||||14.1||

> Notes:
> 1. Don't support destructuring assignment in ESM statement;
> 1. Need `fetch` polyfill in top window;
> 1. Need `URL` polyfill in top window;

Use polyfills:
```js
import "fetch polyfill";
import "URL polyfill";
import "shadowrealm-api/dist/polyfill";
// Your codes
```

## Contact
1. WeChat: cai_fanwei
1. QQ Group: 663286147
1. E-mail: ambit_tsai@qq.com