summaryrefslogtreecommitdiffstats
path: root/docs/code-quality/lint/linters/eslint-plugin-mozilla/use-chromeutils-import.rst
blob: c38304193ada8416d62816993497d0515d083cdc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
use-chromeutils-import
======================

Require use of ``ChromeUtils.import`` and ``ChromeUtils.defineModuleGetter``
rather than ``Components.utils.import`` and
``XPCOMUtils.defineLazyModuleGetter``.

Examples of incorrect code for this rule:
-----------------------------------------

.. code-block:: js

    Components.utils.import("resource://gre/modules/AppConstants.jsm", this);
    XPCOMUtils.defineLazyModuleGetter(this, "AppConstants", "resource://gre/modules/AppConstants.jsm");

Examples of correct code for this rule:
---------------------------------------

.. code-block:: js

    ChromeUtils.import("resource://gre/modules/AppConstants.jsm", this);
    ChromeUtils.defineModuleGetter(this, "AppConstants", "resource://gre/modules/AppConstants.jsm");
    // 4 argument version of defineLazyModuleGetter is allowed.
    XPCOMUtils.defineLazyModuleGetter(this, "AppConstants","resource://gre/modules/AppConstants.jsm","Foo");