src: deprecate undocumented variables

The `root` and `GLOBAL` were never documented. PR-URL: #1838 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Reviewed By: Sakthipriyan Vairamani <[email protected]>
nodejs · Feb 10, 2016 · 4e46931 · 4e46931
1 parent b212be0
commit 4e46931
Showing 1 changed file with 21 additions and 2 deletions.
diff --git a/src/node.js b/src/node.js
@@ -222,8 +222,27 @@
   startup.globalVariables = function() {
     global.process = process;
     global.global = global;
-    global.GLOBAL = global;
-    global.root = global;
+    const util = NativeModule.require('util');
+
+    // Deprecate GLOBAL and root
+    ['GLOBAL', 'root'].forEach(function(name) {
+      // getter
+      const get = util.deprecate(function() {
+        return this;
+      }, `'${name}' is deprecated, use 'global'`);
+      // setter
+      const set = util.deprecate(function(value) {
+        Object.defineProperty(this, name, {
+          configurable: true,
+          writable: true,
+          enumerable: true,
+          value: value
+        });
+      }, `'${name}' is deprecated, use 'global'`);
+      // define property
+      Object.defineProperty(global, name, { get, set, configurable: true });
+    });
+
     global.Buffer = NativeModule.require('buffer').Buffer;
     process.domain = null;
     process._exiting = false;