1955612 - Explain more about the namespace object of the system modules?

Status: RESOLVED FIXED

(Developer Infrastructure :: Source Documentation, enhancement)

Description

[Tooru Fujisawa [:arai]]

https://searchfox.org/mozilla-central/source/docs/jsloader/system-modules.rst

The examples is specific for using single named export.

There seems to be multiple in-tree consumers of namespace objects, and it would be nice to explain more about the namespace object, and how it's actually working in the destructuring assignment and the lazy getters.

Comment 1

[Tooru Fujisawa [:arai]]

possible things to cover:

// Standard namespace import.
import * as ns from "URL";

// Standard namespace import with dynamic import.
const ns = await import("URL");

// System module variant of namespace import.
const ns = ChromeUtils.importESModule("URL");

// Possible workaround for lazy getter.
ChromeUtils.defineLazyGetter(lazy, "ns", () => ChromeUtils.importESModule("URL"));

Comment 2

[Tooru Fujisawa [:arai]]

Attachment: Bug 1955612 - Part 1: In system modules documentation, use different names between the module filename and exported symbols. r?Standard8!

Comment 3

[Tooru Fujisawa [:arai]]

Attachment: Bug 1955612 - Part 2: Add a section for the namespace object usage in the system modules. r?Standard8!

Comment 4

[Tooru Fujisawa [:arai]]

Attachment: Bug 1955612 - Part 3: Add a section for the global variable lifetime. r?Standard8!

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/7253f24ed3c8
Part 1: In system modules documentation, use different names between the module filename and exported symbols. r=Standard8
https://hg.mozilla.org/integration/autoland/rev/85708ecb1bb0
Part 2: Add a section for the namespace object usage in the system modules. r=Standard8,julienw
https://hg.mozilla.org/integration/autoland/rev/fd1beda69932
Part 3: Add a section for the global variable lifetime. r=Standard8

Comment 6

[Serban Stanca [:SerbanS]]

https://hg.mozilla.org/mozilla-central/rev/7253f24ed3c8
https://hg.mozilla.org/mozilla-central/rev/85708ecb1bb0
https://hg.mozilla.org/mozilla-central/rev/fd1beda69932