Files
58c2c80401 Migrate from Yarn to pnpm (#246)
* 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]>
2026-02-16 20:35:52 +00:00

6.8 KiB
Raw Permalink Blame History

quickjs-emscripten


quickjs-emscripten / quickjs-emscripten-core / CustomizeVariantOptions

Interface: CustomizeVariantOptions

Defined in: packages/quickjs-emscripten-core/src/from-variant.ts:119

Contents

Properties

emscriptenModule?

optional emscriptenModule: EmscriptenModuleLoaderOptions

Defined in: packages/quickjs-emscripten-core/src/from-variant.ts:153

The enumerable properties of this object will be passed verbatim, although they may be overwritten if you pass other options.


locateFile()?

optional locateFile: (fileName, prefix) => string

Defined in: packages/quickjs-emscripten-core/src/from-variant.ts:151

If set, this method will be called when the runtime needs to load a file, such as a .wasm WebAssembly file, .mem memory init file, or a file generated by the file packager.

The function receives two parameters:

  • fileName, the relative path to the file as configured in build process, eg "emscripten-module.wasm".
  • prefix (path to the main JavaScript file’s directory). This may be '' (empty string) in some cases if the Emscripten Javascript code can't locate itself. Try logging it in your environment.

It should return the actual URI or path to the requested file.

This lets you host file packages on a different location than the directory of the JavaScript file (which is the default expectation), for example if you want to host them on a CDN.

If set, this method will be called when the runtime needs to load a file, such as a .wasm WebAssembly file, .mem memory init file, or a file generated by the file packager.

The function receives two parameters:

  • fileName, the relative path to the file as configured in build process, eg "emscripten-module.wasm".
  • prefix (path to the main JavaScript file’s directory). This may be '' (empty string) in some cases if the Emscripten Javascript code can't locate itself. Try logging it in your environment.

It should return the actual URI or path to the requested file.

This lets you host file packages on a different location than the directory of the JavaScript file (which is the default expectation), for example if you want to host them on a CDN.

Parameters

fileName

string

prefix

string

Often '' (empty string)

Returns

string


log()?

optional log: {(...data): void; (message?, ...optionalParams): void; }

Defined in: packages/quickjs-emscripten-core/src/from-variant.ts:155

Debug logger

Call Signature

(...data): void

The console.log() static method outputs a message to the console.

MDN Reference

Parameters
data

...any[]

Returns

void

Call Signature

(message?, ...optionalParams): void

Prints to stdout with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).

const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout

See util.format() for more information.

Parameters
message?

any

optionalParams

...any[]

Returns

void

Since

v0.1.100


wasmBinary?

optional wasmBinary: OrLoader<ArrayBuffer>

Defined in: packages/quickjs-emscripten-core/src/from-variant.ts:123

If given, Emscripten will compile the WebAssembly.Module from these bytes.


wasmLocation?

optional wasmLocation: string

Defined in: packages/quickjs-emscripten-core/src/from-variant.ts:121

If given, Emscripten will try to load the WebAssembly module data from this location (path or URI) as appropriate for the current platform.


wasmMemory?

optional wasmMemory: OrLoader<Memory>

Defined in: packages/quickjs-emscripten-core/src/from-variant.ts:127

If given, use the Memory when instantiating the WebAssembly.Instance.


wasmModule?

optional wasmModule: OrLoader<Module>

Defined in: packages/quickjs-emscripten-core/src/from-variant.ts:125

If given, Emscripten will instantiate the WebAssembly.Instance from this existing WebAssembly.Module


wasmSourceMapData?

optional wasmSourceMapData: OrLoader<string | SourceMapData>

Defined in: packages/quickjs-emscripten-core/src/from-variant.ts:131

If given, we will provide the source map to Emscripten directly. This may only be respected if wasmModule is also provided.


wasmSourceMapLocation?

optional wasmSourceMapLocation: string

Defined in: packages/quickjs-emscripten-core/src/from-variant.ts:129

If given, Emscripten will try to load the source map for the WebAssembly module from this location (path or URI) as appropriate for the current platform.