Documentation

Extensions Reference: File Functions

Extensions Reference: File Functions¶

API Reference
File Functions

require

require¶

Argument: module: string: None
relative path to module

Returns: None: object
The value of value of module.exports

Import a module and return the value of module.exports, matching the behavior of CommonJS / Node.js modules. The module must be present in the extension directory and the module name should be a relative path to the module (specifying a .js extension is optional).

Important! Previous to API version 0.2.0, this function behaved like the current loadScript() function does.

Here’s what can be done to have a statement matching both behaviors:

(function(root) {
  if (typeof bundle === 'object' && bundle.minApiVersion('0.2.0')) {
        root.Mustache = require("./mustache");
  }
  else {
        require("mustache.js");
  }
})(this);

loadScript

loadScript¶

Argument: filename: string: None
relative path to file

You can split your Extension code between several JavaScript files. The main script remains the one that named after the last component of the identifier. Other script (dependencies), can be loaded inline the current script using the loadScript() function (e.g. loadScript("my-other-script.js") will load the my-other-script.js script, provided it is located in the same Extension directory).

Important! This function does not return the imported module, use require() if you wish to have a return value (similar to Node.js/CommonJS).

readFile

readFile¶

Argument: filename: string: None
relative path to file

Returns: None: string
files data read as a string

It may be handy to store files in your Extension directory, and then read their content from your script (e.g. for templates). Use the readFile() function for that purpose.