doc: require behavior on case-insensitive systems

This adds a paragraph in the Module Caching Caveats section about the behavior of require when Node is running on top of a file system (e.g. HFS) or operating system (e.g. Windows) that will not consider the case of file paths to find files. Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Alexis Campailla <[email protected]> Reviewed-By: Rod Vagg <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
nodejs · Feb 28, 2016 · 378a772 · 378a772
1 parent 06b7eb6
commit 378a772
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/api/modules.markdown b/doc/api/modules.markdown
@@ -212,6 +212,12 @@ module (loading from `node_modules` folders), it is not a *guarantee*
 that `require('foo')` will always return the exact same object, if it
 would resolve to different files.
 
+Additionally, on case-insensitive file systems or operating systems, different
+resolved filenames can point to the same file, but the cache will still treat
+them as different modules and will reload the file multiple times. For example,
+`require('./foo')` and `require('./FOO')` return two different objects,
+irrespective of whether or not `./foo` and `./FOO` are the same file.
+
 ## Core Modules
 
 <!--type=misc-->