Skip to content

Latest commit

 

History

History
94 lines (67 loc) · 2.95 KB

README.md

File metadata and controls

94 lines (67 loc) · 2.95 KB

quickjs-emscripten • @jitl/quickjs-singlefile-cjs-debug-sync • Readme | Exports

@jitl/quickjs-singlefile-cjs-debug-sync

Variant with the WASM data embedded into a universal (Node and Browser compatible) CommonJS module.

This generated package is part of quickjs-emscripten. It contains a variant of the quickjs WASM library, and can be used with quickjs-emscripten-core.

import variant from "@jitl/quickjs-singlefile-cjs-debug-sync"
import { newQuickJSWASMModuleFromVariant } from "quickjs-emscripten-core"
const QuickJS = await newQuickJSWASMModuleFromVariant(variant)

This variant was built with the following settings:

Contents

Library: quickjs

The original bellard/quickjs library.

Version 2024-02-14+36911f0d vendored to quickjs-emscripten on 2024-06-15.

Release mode: debug

Enables assertions and memory sanitizers. Try to run your tests against debug variants, in addition to your preferred production variant, to catch more bugs.

Exports: require

Exports the following in package.json for the package entrypoint:

  • Exports a NodeJS-compatible CommonJS module, which is faster to load and run compared to an ESModule.

Extra async magic? No

The default, normal build. Note that both variants support regular async functions.

Single-file, or separate .wasm file? singlefile

The WASM runtime is included directly in the JS file. Use if you run into issues with missing .wasm files when building or deploying your app.

More details

Full variant JSON description:

{
  "library": "quickjs",
  "releaseMode": "debug",
  "syncMode": "sync",
  "description": "Variant with the WASM data embedded into a universal (Node and Browser compatible) CommonJS module.",
  "emscriptenInclusion": "singlefile",
  "exports": {
    "require": {
      "emscriptenEnvironment": ["web", "worker", "node"]
    }
  }
}

Variant-specific Emscripten build flags:

[
  "-O0",
  "-DQTS_DEBUG_MODE",
  "-DDUMP_LEAKS=1",
  "-gsource-map",
  "-s ASSERTIONS=1",
  "--pre-js $(TEMPLATES)/pre-extension.js",
  "--pre-js $(TEMPLATES)/pre-sourceMapJson.js",
  "--pre-js $(TEMPLATES)/pre-wasmOffsetConverter.js",
  "--pre-js $(TEMPLATES)/pre-wasmMemory.js",
  "-s SINGLE_FILE=1",
  "-DQTS_SANITIZE_LEAK",
  "-fsanitize=leak",
  "-g2"
]

Generated using typedoc-plugin-markdown and TypeDoc