doc: note ability to require files within packages

Adding note to api/modules.markdown about ability to load arbitrary path from modules from node_module path by adding reference to path after module name in call to require() PR-URL: #7794 Reviewed-by: Trevor Norris <[email protected]> Reviewed-by: Fedor Indutny <[email protected]> Reviewed-by: Timothy J Fontaine <[email protected]>
nodejs · Nov 10, 2014 · fd22268 · fd22268
1 parent d8a3c4a
commit fd22268
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/api/modules.markdown b/doc/api/modules.markdown
@@ -175,6 +175,12 @@ this order:
 This allows programs to localize their dependencies, so that they do not
 clash.
 
+You can require specific files or sub modules distributed with a module by
+including a path suffix after the module name. For instance
+`require('example-module/path/to/file')` would resolve `path/to/file`
+relative to where `example-module` is located. The suffixed path follows the
+same module resolution semantics.
+
 ## Folders as Modules
 
 <!--type=misc-->