Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add ESM examples in module API doc page #34875

Closed
wants to merge 3 commits into from
Closed
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 23 additions & 4 deletions doc/api/module.md
Expand Up @@ -7,8 +7,8 @@
* {Object}

Provides general utility methods when interacting with instances of
`Module`, the `module` variable often seen in file modules. Accessed
via `require('module')`.
`Module`, the [`module`][] variable often seen in CommonJS modules. Accessed
aduh95 marked this conversation as resolved.
Show resolved Hide resolved
via `import 'module'` or `require('module')`.

### `module.builtinModules`
<!-- YAML
Expand All @@ -27,6 +27,14 @@ if a module is maintained by a third party or not.
by the [module wrapper][]. To access it, require the `Module` module:

```js
// module.mjs
// In an ECMAScript module
import { builtinModules as builtin } from 'module';
```

```js
// module.cjs
// In a CommonJS module
const builtin = require('module').builtinModules;
```

Expand Down Expand Up @@ -74,8 +82,8 @@ added: v12.12.0
-->

The `module.syncBuiltinESMExports()` method updates all the live bindings for
builtin ES Modules to match the properties of the CommonJS exports. It does
not add or remove exported names from the ES Modules.
builtin [ES Modules][] to match the properties of the [CommonJS][] exports. It
does not add or remove exported names from the [ES Modules][].

```js
const fs = require('fs');
Expand Down Expand Up @@ -116,6 +124,14 @@ To enable source map parsing, Node.js must be run with the flag
[`NODE_V8_COVERAGE=dir`][].

```js
// module.mjs
// In an ECMAScript module
import { findSourceMap, SourceMap } from 'module';
```

```js
// module.cjs
// In a CommonJS module
const { findSourceMap, SourceMap } = require('module');
```

Expand Down Expand Up @@ -192,3 +208,6 @@ consists of the following keys:
[`createRequire()`]: #module_module_createrequire_filename
[module wrapper]: modules_cjs.html#modules_cjs_the_module_wrapper
[source map include directives]: https://sourcemaps.info/spec.html#h.lmz475t4mvbx
[`module`]: modules.html#modules_the_module_object
[CommonJS]: modules.html
[ES Modules]: esm.html