diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 075a620b403407..7bce3bcff3a91b 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -2617,6 +2617,24 @@ async function openAndClose() { } ``` + +### DEP0138: `process.mainModule` + + +Type: Documentation-only + +[`process.mainModule`][] is a CommonJS-only feature while `process` global +object is shared with non-CommonJS environment. Its use within ECMAScript +modules is unsupported. + +It is deprecated in favor of [`require.main`][], because it serves the same +purpose and is only available on CommonJS environment. + [`--pending-deprecation`]: cli.html#cli_pending_deprecation [`--throw-deprecation`]: cli.html#cli_throw_deprecation [`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size @@ -2674,8 +2692,10 @@ async function openAndClose() { [`os.networkInterfaces()`]: os.html#os_os_networkinterfaces [`os.tmpdir()`]: os.html#os_os_tmpdir [`process.env`]: process.html#process_process_env +[`process.mainModule`]: process.html#process_process_mainmodule [`punycode`]: punycode.html [`require.extensions`]: modules.html#modules_require_extensions +[`require.main`]: modules.html#modules_accessing_the_main_module [`request.socket`]: http.html#http_request_socket [`request.connection`]: http.html#http_request_connection [`response.socket`]: http.html#http_response_socket diff --git a/doc/api/process.md b/doc/api/process.md index 5c31bb8415a872..1c1089ca6b8b5d 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -1499,8 +1499,11 @@ debugger. See [Signal Events][]. ## `process.mainModule` +> Stability: 0 - Deprecated: Use [`require.main`][] instead. + * {Object} The `process.mainModule` property provides an alternative way of retrieving