Module object

Module is a global JavaScript object with attributes that Emscripten-generated code calls at various points in its execution.

Developers can provide an implementation of Module to control the execution of code. For example, to define how notification messages from Emscripten are displayed, developers implement the Module.print attribute.

Note

Module is also used to provide access to all Emscripten API functions (for example ccall()) in a way that avoids issues with function name minification at higher optimisation levels. These functions are documented as part of their own APIs.

Creating the Module object

Use emcc’s pre-js option to add JavaScript code that defines (or extends) the Module object with the behaviour you need.

When generating only JavaScript (as opposed to HTML), no Module object is created by default, and the behaviour is entirely defined by the developer. For example, creating a Module object with the following code will cause all notifications from the program to be calls to alert().

var Module = {
  'print': function(text) { alert('stdout: ' + text) }
  'printErr': function(text) { alert('stderr: ' + text) }
};

Important

If you run the Closure Compiler on your code (which is optional, and can be done by --closure 1), you will need quotation marks around the properties of Module as in the example above. In addition, you need to run closure on the compiled code together with the declaration of Module — this is done automatically for a -pre-js file.

When generating HTML, Emscripten creates a Module object with default methods (see src/shell.html). In this case you should again use --pre-js, but this time you add properties to the existing Module object, for example

Module['print'] = function(text) { alert('stdout: ' + text) };

Affecting execution

The following Module attributes affect code execution.

Module.print

Called when something is printed to standard output (stdout)

Module.printErr

Called when something is printed to standard error (stderr)

Module.arguments

The commandline arguments. The value of arguments contains the values returned if compiled code checks argc and argv.

Module.preInit

A function (or array of functions) that must be called before global initializers run, but after basic initialization of the JavaScript runtime. This is typically used for File System operations.

Module.preRun

An array of functions to call right before calling run(), but after defining and setting up the environment, including global initializers. This is useful, for example, to set up directories and files using the File System API — as this needs to happen after the FileSystem API has been loaded, but before the program starts to run.

Note

If code needs to affect global initializers, it should instead be run using preInit.

Module.noInitialRun

If noInitialRun is set to true, main() will not be automatically called (you can do so yourself later). The program will still call global initializers, set up memory initialization, and so forth.

Module.noExitRuntime

If noExitRuntime is set to true, the runtime is not shut down after run completes. Shutting down the runtime calls shutdown callbacks, for example atexit calls. If you want to continue using the code after run() finishes, it is necessary to set this. This is automatically set for you if you use an API command that implies that you want the runtime to not be shut down, for example emscripten_set_main_loop.

Module.filePackagePrefixURL

This is the “prefix” URL for a preloaded data file that is hosted separately from its JavaScript and HTML files (it includes the full path up to, but not including, the data file). See Changing the data file location for more information.

Module.locateFile

If set, this method will be called when the runtime needs to load either a file generated by the file packager (this is a generalization of Module.filePackagePrefixURL), or the .mem memory init file. In both cases the function receives the URL, and should return the actual URL. This lets you host file packages or the .mem file on a different location than the current directory (which is the default expectation), for example if you want to host them on a CDN.

Module.logReadFiles

If set, Module.printErr will log when any file is read.

Module.preinitializedWebGLContext

If building with -s GL_PREINITIALIZED_CONTEXT=1 set, you can set Module.preinitializedWebGLContext to a precreated instance of a WebGL context, which will be used later when initializing WebGL in C/C++ side. Precreating the GL context is useful if doing GL side loading (shader compilation, texture loading etc.) parallel to other page startup actions, and/or for detecting WebGL feature support, such as GL version or compressed texture support up front on a page before or in parallel to loading up any compiled code.

Other methods

Module.destroy(obj)

This method should be called to destroy C++ objects created in JavaScript using WebIDL bindings. If this method is not called, an object may be garbage collected, but its destructor will not be called.

Arguments:
  • obj – The JavaScript-wrapped C++ object to be destroyed.
Module.onCustomMessage()

When compiled with PROXY_TO_WORKER = 1 (see settings.js), this callback (which should be implemented on both the client and worker’s Module object) allows sending custom messages and data between the web worker and the main thread (using the postCustomMessage function defined in proxyClient.js and proxyWorker.js).

Module.instantiateWasm()

When targeting WebAssembly, Module.instantiateWasm is an optional user-implemented callback function that the Emscripten runtime calls to perform the WebAssembly instantiation action. The callback function will be called with two parameters, imports and successCallback. imports is a JS object which contains all the function imports that need to be passed to the WebAssembly Module when instantiating, and once instantiated, this callback function should call successCallback() with the generated WebAssembly Instance object.

The instantiation can be performed either synchronously or asynchronously. The return value of this function should contain the exports object of the instantiated WebAssembly Module, or an empty dictionary object {} if the instantiation is performed asynchronously, or false if instantiation failed.

Overriding the WebAssembly instantiation procedure via this function is useful when you have other custom asynchronous startup actions or downloads that can be performed in parallel to WebAssembly compilation. Implementing this callback allows performing all of these in parallel. See the file tests/manual_wasm_instantiate.html and the test browser.test_manual_wasm_instantiate for an example of how this construct works in action.

Module.getPreloadedPackage()

If you want to manually manage the download of .data file packages for custom caching, progress reporting and error handling behavior, you can implement the Module.getPreloadedPackage = function(remotePackageName, remotePackageSize) callback to provide the contents of the data files back to the file loading scripts. The return value of this callback should be an Arraybuffer with the contents of the downloade file data. See file tests/manual_download_data.html and the test browser.test_preload_file_with_manual_data_download for an example.

Overriding execution environment

The generated program is able to detect its execution environment by checking the presence of some typical objects of the environment itself (such as window for browsers).

However, sometimes it may be needed to override the detected environment: a typical use case would be module bundlers (like webpack): they are executed by nodejs but the final output is for browser.

In order to do that, you can dictate your preferred execution environment by setting the Module.ENVIRONMENT variable to one of those allowed values:

WEB

WORKER

NODE

SHELL

In that case, Module will honor your preference and skip auto detection.