doc: add require.extensions to globals

Closes #3028
nodejs · Apr 17, 2012 · 718aa50 · 718aa50
1 parent 7cd1690
commit 718aa50
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/doc/api/globals.markdown b/doc/api/globals.markdown
@@ -61,6 +61,24 @@ but rather than loading the module, just return the resolved filename.
 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.
 
+### require.extensions
+
+* {Array}
+
+Instruct `require` on how to handle certain file extensions.
+
+Process files with the extension `.sjs` as `.js`:
+
+    require.extensions['.sjs'] = require.extensions['.js'];
+
+Write your own extension handler:
+
+    require.extensions['.sjs'] = function(module, filename) {
+      var content = fs.readFileSync(filename, 'utf8');
+      // Parse the file content and give to module.exports
+      module.exports = content;
+    };
+
 ## __filename
 
 <!-- type=var -->