doc: add require.extensions to globals
authorKyle Robinson Young <kyle@dontkry.com>
Tue, 17 Apr 2012 05:15:51 +0000 (22:15 -0700)
committerBen Noordhuis <info@bnoordhuis.nl>
Tue, 17 Apr 2012 15:10:42 +0000 (17:10 +0200)
Closes #3028

doc/api/globals.markdown

index 5df0b9e..d8fb257 100644 (file)
@@ -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 -->