* Migrate from Yarn to pnpm - Replace Yarn 4.0.2 with pnpm 10.29.3 as the package manager - Add pnpm-workspace.yaml and .npmrc configuration - Update all scripts to use pnpm commands - Rename getYarnWorkspaces() to getWorkspaces() in scripts/helpers.ts - Update CI workflow to use pnpm/action-setup@v4 with Node 22 - Add @jitl/tsconfig as root devDependency for proper resolution - Add variant packages as devDependencies for test resolution - Fix TypeScript 5.9 compatibility in memory.ts (Int32Array<ArrayBuffer>) - Upgrade typedoc to 0.28.17 for TypeScript 5.9 support - Upgrade typedoc-plugin-markdown to 4.10.0 - Regenerate documentation with new typedoc version * Clarify git commit --amend rule in CLAUDE.md * CI: Add --ignore-scripts to pnpm install Equivalent to yarn's YARN_ENABLE_SCRIPTS=0 - prevents prepare scripts from running during install, which would fail on a fresh checkout. * Fix pnpm tarball naming in smoketest scripts pnpm pack generates tarball names like jitl-quickjs-ffi-types-0.32.0.tgz (without @ prefix, with version) instead of @jitl-quickjs-ffi-types.tgz * Update examples to TypeScript 5.9 for compatibility The library now requires TypeScript 5.9+ due to stricter typed array generics (Int32Array<ArrayBuffer>). Update all TypeScript-using examples. * Use --legacy-peer-deps for create-react-app smoketest react-scripts@5 only supports TypeScript 3.x/4.x, but our library now requires TypeScript 5.9+ for typed array generics. Use --legacy-peer-deps to work around the peer dependency conflict. * Fix formatting issues * Fix remaining formatting issues * Add reminder to run prettier and lint before pushing * Document CI workflow in CLAUDE.md * Add typedoc.json and remark plugins for in-page table of contents - Add typedoc-plugin-remark, remark-toc, and remark-insert-headings - Configure remark plugins to generate "Contents" section for Class, Interface, Enum, TypeAlias, and Function pages - This restores the in-page TOC that lists methods/properties that was removed in typedoc-plugin-markdown 4.3.0 * Use custom remark plugin for headless TOC in docs Replace remark-insert-headings + remark-toc with a custom plugin that inserts the table of contents directly after the class description, without a separate "Contents" heading. * Revert to standard remark plugins for TOC with Contents heading Use remark-insert-headings + remark-toc instead of custom plugin. Remove mdast-util-toc dependency and custom remark-toc-headless.mjs. * Fix lockfile - remove mdast-util-toc * Ignore pnpm-lock.yaml in prettier, update .yarn to .pnpm --------- Co-authored-by: Hanzo Dev <[email protected]>
4.8 KiB
quickjs-emscripten / quickjs-emscripten-core / QuickJSWASMModule
Class: QuickJSWASMModule
Defined in: packages/quickjs-emscripten-core/src/module.ts:326
This class presents a Javascript interface to QuickJS, a Javascript interpreter that supports EcmaScript 2020 (ES2020).
It wraps a single WebAssembly module containing the QuickJS library and associated helper C code. WebAssembly modules are completely isolated from each other by the host's WebAssembly runtime. Separate WebAssembly modules have the most isolation guarantees possible with this library.
The simplest way to start running code is evalCode. This shortcut method will evaluate Javascript safely and return the result as a native Javascript value.
For more control over the execution environment, or to interact with values inside QuickJS, create a context with newContext or a runtime with newRuntime.
Contents
Extended by
Methods
evalCode()
evalCode(
code,options?):unknown
Defined in: packages/quickjs-emscripten-core/src/module.ts:410
One-off evaluate code without needing to create a QuickJSRuntime or QuickJSContext explicitly.
To protect against infinite loops, use the shouldInterrupt option. The
shouldInterruptAfterDeadline function will create a time-based deadline.
If you need more control over how the code executes, create a QuickJSRuntime (with newRuntime) or a QuickJSContext (with newContext or QuickJSRuntime#newContext), and use its QuickJSContext#evalCode method.
Asynchronous callbacks may not run during the first call to evalCode. If
you need to work with async code inside QuickJS, create a runtime and use
QuickJSRuntime#executePendingJobs.
Parameters
code
string
options?
ModuleEvalOptions = {}
Returns
unknown
The result is coerced to a native Javascript value using JSON serialization, so properties and values unsupported by JSON will be dropped.
Throws
If code throws during evaluation, the exception will be
converted into a native Javascript value and thrown.
Throws
if options.shouldInterrupt interrupted execution, will throw a Error
with name "InternalError" and message "interrupted".
getWasmMemory()
getWasmMemory():
Memory
Defined in: packages/quickjs-emscripten-core/src/module.ts:441
Experimental
Retrieve the WebAssembly memory used by this QuickJS module. Use this access very carefully - you are responsible for safe interaction with the memory.
To supply a custom, pre-initialized memory to QuickJS, create a new variant and provide the CustomizeVariantOptions#wasmMemory option.
Returns
Memory
newContext()
newContext(
options?):QuickJSContext
Defined in: packages/quickjs-emscripten-core/src/module.ts:375
A simplified API to create a new QuickJSRuntime and a QuickJSContext inside that runtime at the same time. The runtime will be disposed when the context is disposed.
Parameters
options?
ContextOptions = {}
Returns
newRuntime()
newRuntime(
options?):QuickJSRuntime
Defined in: packages/quickjs-emscripten-core/src/module.ts:346
Create a runtime. Use the runtime to set limits on CPU and memory usage and configure module loading for one or more QuickJSContexts inside the runtime.
Parameters
options?
RuntimeOptions = {}