quickjs-emscripten

---

quickjs-emscripten / quickjs-emscripten-core / CustomizeVariantOptions

Interface: CustomizeVariantOptions

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

Contents

• Properties
  • emscriptenModule?
  • locateFile()?
  • log()?
  • wasmBinary?
  • wasmLocation?
  • wasmMemory?
  • wasmModule?
  • wasmSourceMapData?
  • wasmSourceMapLocation?

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.