Skip to content

Latest commit

 

History

History
95 lines (68 loc) · 3.61 KB

README.md

File metadata and controls

95 lines (68 loc) · 3.61 KB

quickjs-emscripten • @jitl/quickjs-singlefile-cjs-release-asyncify • Readme | Exports

@jitl/quickjs-singlefile-cjs-release-asyncify

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-release-asyncify"
import { newQuickJSAsyncWASMModuleFromVariant } from "quickjs-emscripten-core"
const QuickJS = await newQuickJSAsyncWASMModuleFromVariant(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: release

Optimized for performance; use when building/deploying your application.

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? Yes

Build run through the ASYNCIFY WebAssembly transform. This imposes substantial size (2x the size of sync) and speed penalties (40% the speed of sync). In return, allows synchronous calls from the QuickJS WASM runtime to async functions on the host. The extra magic makes this variant slower than sync variants. Note that both variants support regular async functions. Only adopt ASYNCIFY if you need to! The QuickJSAsyncRuntime and QuickJSAsyncContext classes expose the ASYNCIFY-specific APIs.

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": "release",
  "syncMode": "asyncify",
  "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:

[
  "-s ASYNCIFY=1",
  "-DQTS_ASYNCIFY=1",
  "-DQTS_ASYNCIFY_DEFAULT_STACK_SIZE=81920",
  "-s ASYNCIFY_STACK_SIZE=81920",
  "-s ASYNCIFY_REMOVE=@$(BUILD_WRAPPER)/asyncify-remove.json",
  "-s ASYNCIFY_IMPORTS=@$(BUILD_WRAPPER)/asyncify-imports.json",
  "-lasync.js",
  "-Oz",
  "-flto",
  "--closure 1",
  "-s FILESYSTEM=0",
  "--pre-js $(TEMPLATES)/pre-extension.js",
  "--pre-js $(TEMPLATES)/pre-wasmMemory.js",
  "-s SINGLE_FILE=1"
]

Generated using typedoc-plugin-markdown and TypeDoc