|
| 1 | +[quickjs-emscripten](../../packages.md) • **@jitl/quickjs-asmjs-mjs-release-sync** • [Readme](README.md) \| [Exports](exports.md) |
| 2 | + |
| 3 | +*** |
| 4 | + |
| 5 | +# @jitl/quickjs-asmjs-mjs-release-sync |
| 6 | + |
| 7 | +Compiled to pure Javascript, no WebAssembly required. |
| 8 | + |
| 9 | +This generated package is part of [quickjs-emscripten](https://github.com/justjake/quickjs-emscripten). |
| 10 | +It contains a variant of the quickjs WASM library, and can be used with quickjs-emscripten-core. |
| 11 | + |
| 12 | +```typescript |
| 13 | +import variant from "@jitl/quickjs-asmjs-mjs-release-sync" |
| 14 | +import { newQuickJSWASMModuleFromVariant } from "quickjs-emscripten-core" |
| 15 | +const QuickJS = await newQuickJSWASMModuleFromVariant(variant) |
| 16 | +``` |
| 17 | + |
| 18 | +This variant was built with the following settings: |
| 19 | + |
| 20 | +## Contents |
| 21 | + |
| 22 | +- [Library: quickjs](README.md#library-quickjs) |
| 23 | +- [Release mode: release](README.md#release-mode-release) |
| 24 | +- [Exports: import](README.md#exports-import) |
| 25 | +- [Extra async magic? No](README.md#extra-async-magic-no) |
| 26 | +- [Single-file, or separate .wasm file? asmjs](README.md#single-file-or-separate-wasm-file-asmjs) |
| 27 | +- [More details](README.md#more-details) |
| 28 | + |
| 29 | +## Library: quickjs |
| 30 | + |
| 31 | +The original [bellard/quickjs](https://github.com/bellard/quickjs) library. |
| 32 | + |
| 33 | +Version [2024-02-14+36911f0d](https://github.com/bellard/quickjs/commit/36911f0d3ab1a4c190a4d5cbe7c2db225a455389) vendored to quickjs-emscripten on 2024-06-15. |
| 34 | + |
| 35 | +## Release mode: release |
| 36 | + |
| 37 | +Optimized for performance; use when building/deploying your application. |
| 38 | + |
| 39 | +## Exports: import |
| 40 | + |
| 41 | +Exports the following in package.json for the package entrypoint: |
| 42 | + |
| 43 | +- Exports a NodeJS-compatible ESModule. Cannot be imported synchronously from a NodeJS CommonJS module. |
| 44 | + |
| 45 | +## Extra async magic? No |
| 46 | + |
| 47 | +The default, normal build. Note that both variants support regular async functions. |
| 48 | + |
| 49 | +## Single-file, or separate .wasm file? asmjs |
| 50 | + |
| 51 | +The C library code is compiled to Javascript, no WebAssembly used. Sometimes called "asmjs". This is the slowest possible option, and is intended for constrained environments that do not support WebAssembly, like quickjs-for-quickjs. |
| 52 | + |
| 53 | +## More details |
| 54 | + |
| 55 | +Full variant JSON description: |
| 56 | + |
| 57 | +```json |
| 58 | +{ |
| 59 | + "library": "quickjs", |
| 60 | + "releaseMode": "release", |
| 61 | + "syncMode": "sync", |
| 62 | + "description": "Compiled to pure Javascript, no WebAssembly required.", |
| 63 | + "emscriptenInclusion": "asmjs", |
| 64 | + "exports": { |
| 65 | + "import": { |
| 66 | + "emscriptenEnvironment": ["web", "worker", "node"] |
| 67 | + } |
| 68 | + } |
| 69 | +} |
| 70 | +``` |
| 71 | + |
| 72 | +Variant-specific Emscripten build flags: |
| 73 | + |
| 74 | +```json |
| 75 | +[ |
| 76 | + "-Oz", |
| 77 | + "-flto", |
| 78 | + "--closure 1", |
| 79 | + "-s FILESYSTEM=0", |
| 80 | + "--pre-js $(TEMPLATES)/pre-extension.js", |
| 81 | + "--pre-js $(TEMPLATES)/pre-wasmMemory.js", |
| 82 | + "-s WASM=0", |
| 83 | + "-s SINGLE_FILE=1" |
| 84 | +] |
| 85 | +``` |
| 86 | + |
| 87 | +*** |
| 88 | + |
| 89 | +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) |
0 commit comments