summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBryan English <bryan@bryanenglish.com>2016-04-12 11:10:49 -0700
committerJames M Snell <jasnell@gmail.com>2016-04-18 15:17:41 -0700
commit5c14d695d2c1f924cf06af6ae896027569993a5c (patch)
tree39299adeb7b80a0cc6612798354b19e2eaeb1f3f /doc
parent58561cf6a8ce6ac907973c3813cb52134ec8d4c2 (diff)
downloadandroid-node-v8-5c14d695d2c1f924cf06af6ae896027569993a5c.tar.gz
android-node-v8-5c14d695d2c1f924cf06af6ae896027569993a5c.tar.bz2
android-node-v8-5c14d695d2c1f924cf06af6ae896027569993a5c.zip
doc: native module reloading is not supported
Clarify in docs for require.cache that reloading native modules isn't supported. Related: #6160 PR-URL: https://github.com/nodejs/node/pull/6168 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/globals.markdown5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/api/globals.markdown b/doc/api/globals.markdown
index 1e2e0562bd..a43d28eccb 100644
--- a/doc/api/globals.markdown
+++ b/doc/api/globals.markdown
@@ -145,7 +145,9 @@ global but rather local to each module.
* {Object}
Modules are cached in this object when they are required. By deleting a key
-value from this object, the next `require` will reload the module.
+value from this object, the next `require` will reload the module. Note that
+this does not apply to [native addons][], for which reloading will result in an
+Error.
### require.extensions
@@ -199,6 +201,7 @@ but rather than loading the module, just return the resolved filename.
[buffer section]: buffer.html
[module system documentation]: modules.html
[Modules]: modules.html#modules_modules
+[native addons]: addons.html
[timers]: timers.html
[`clearImmediate`]: timers.html#timers_clearimmediate_immediateobject
[`clearInterval`]: timers.html#timers_clearinterval_intervalobject