From 28f1aef7b4ecae339ef2d59a959906217fd2255c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 4 May 2016 18:17:27 +0900 Subject: [PATCH] Remove ELECTRON_HIDE_INTERNAL_MODULES in docs --- docs/api/environment-variables.md | 4 ---- docs/api/synopsis.md | 19 ------------------- 2 files changed, 23 deletions(-) diff --git a/docs/api/environment-variables.md b/docs/api/environment-variables.md index 7339661b09fe..e01afff5fa76 100644 --- a/docs/api/environment-variables.md +++ b/docs/api/environment-variables.md @@ -52,7 +52,3 @@ Don't attach to current console session. ## `ELECTRON_FORCE_WINDOW_MENU_BAR` _Linux_ Don't use global menu bar on Linux. - -## `ELECTRON_HIDE_INTERNAL_MODULES` - -Turns off compatibility mode for old built-in modules like `require('ipc')`. diff --git a/docs/api/synopsis.md b/docs/api/synopsis.md index a2aa58f57f17..fc2ce943932c 100644 --- a/docs/api/synopsis.md +++ b/docs/api/synopsis.md @@ -61,25 +61,6 @@ const {app, BrowserWindow} = require('electron') However if you are using plain JavaScript, you have to wait until Chrome fully supports ES6. -## Disable old styles of using built-in modules - -Before v0.35.0, all built-in modules have to be used in the form of -`require('module-name')`, though it has [many disadvantages][issue-387], we are -still supporting it for compatibility with old apps. - -To disable the old styles completely, you can set the -`ELECTRON_HIDE_INTERNAL_MODULES` environment variable: - -```javascript -process.env.ELECTRON_HIDE_INTERNAL_MODULES = 'true' -``` - -Or call the `hideInternalModules` API: - -```javascript -require('electron').hideInternalModules() -``` - [gui]: https://en.wikipedia.org/wiki/Graphical_user_interface [destructuring-assignment]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment [issue-387]: https://github.com/electron/electron/issues/387