JavaScript code modules

Posted 2022-02-15 chucklu

https://developer.mozilla.org/en-US/docs/Mozilla/JavaScript_code_modules

Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

Note: These are not the same thing as standard javascript modules. See export and import to learn more about how to use standard modules.

JavaScript code modules let multiple privileged JavaScript scopes share code. For example, a module could be used by Firefox itself as well as by extensions, in order to avoid code duplication.

 

Using JavaScript code modules

JavaScript code modules are a concept introduced in Gecko 1.9 and can be used for sharing code between different privileged scopes. Modules can also be used to create global JavaScript singletons that previously required using JavaScript XPCOM objects. A JavaScript code module is simply some JavaScript code located in a registered location. The module is loaded into a specific JavaScript scope, such as XUL script or JavaScript XPCOM script, using Components.utils.import() or Components.utils["import"]().

Creating a JavaScript code moduleSection

A very simple JavaScript module looks like this:

var EXPORTED_SYMBOLS = ["foo", "bar"];

function foo() 
  return "foo";


var bar = 
  name : "bar",
  size : 3
;

var dummy = "dummy";

Notice that the module uses normal JavaScript to create functions, objects, constants, and any other JavaScript type. The module also defines a special Array named EXPORTED_SYMBOLS. Any JavaScript item named in EXPORTED_SYMBOLS will be exported from the module and injected into the importing scope. For example:

Components.utils.import("resource://app/my_module.jsm");

alert(foo());         // displays "foo"
alert(bar.size + 3);  // displays "6"
alert(dummy);         // displays "dummy is not defined" because ‘dummy‘ was not exported from the module

Note: When you‘re testing changes to a code module, be sure to change the application‘s build ID (e.g., the version) before your next test run; otherwise, you may find yourself running the previous version of your module‘s code.

 

The URL for a code moduleSection

As you can see from the example above, you need a URL to import a code module. (The URL in the example is "resource://app/my_module.jsm".)

Code modules can only be loaded using a chrome: (), resource:, or file: URL.

• If you‘re writing an extension for Firefox 4 and already have a chrome.manifest with a content instruction in it, you can put the code module in your content folder and reference it like your other content files via chrome://<yourextension>/content/<yourmodule>.jsm.
• If your extension or application needs to support Mozilla 1.9.x (Firefox 3.x), you should register a new resource URL. Details on doing this are in the "Extending resource: URLs" section below.

Sharing objects using code modulesSection

An extremely important behavior of Components.utils.import() is that modules are cached when loaded and subsequent imports do not reload a new version of the module, but instead use the previously cached version. This means that a given module will be shared when imported multiple times. Any modifications to data, objects, or functions will be available in any scope that has imported the module. For example, if the simple module were imported into two different JavaScript scopes, changes in one scope can be observed in the other scope.

Scope1:

Components.utils.import("resource://app/my_module.jsm");

alert(bar.size + 3);  // displays "6"

bar.size = 10;

Scope2:

Components.utils.import("resource://app/my_module.jsm");

alert(foo());         // displays "foo"
alert(bar.size + 3);  // displays "13"

This sharing behavior can be used to create singleton objects that can share data across windows and between XUL script and XPCOM components.

 

Note: Each scope that imports a module receives a by-value copy of the exported symbols in that module. Changes to the symbol‘s value will not propagate to other scopes (though an object‘s properties will be manipulated by reference).

Scope1:

Components.utils.import("resource://app/my_module.jsm");

bar = "foo";
alert(bar);         // displays "foo"

Scope2:

Components.utils.import("resource://app/my_module.jsm");

alert(bar);         // displays "[object Object]"

 

The main effect of the by-value copy is that global variables of simple types won‘t be shared across scopes. Always put variables in a wrapper class and export the wrapper (such as bar in the above example).

 

Importing CommonJS modulesSection

The JavaScript code modules described here are not the same thing as CommonJS modules, but you can import CommonJS modules into any scope where you can use Components.utils.import. Just call the following:

const  require  = Cu.import("resource://gre/modules/commonjs/toolkit/require.js", )

This will import require() into your scope.

You can then use that to import CommonJS modules. You can import Add-on SDK modules in just the same way you could from an SDK add-on:

// import the SDK‘s base64 module

var base64 = require("sdk/base64");
base64.encode("hello"); // "aGVsbG8="

You can import other CommonJS modules, too, as long as you know the path to them:

// import my module

var myModule = require("resource://path/to/my/module.js");

In this case, though, you might be better off creating your own loader, so you can specify the paths property yourself.