summaryrefslogtreecommitdiffstats
path: root/node_modules/memory-fs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/memory-fs/README.md')
-rw-r--r--node_modules/memory-fs/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/node_modules/memory-fs/README.md b/node_modules/memory-fs/README.md
new file mode 100644
index 0000000..d4542c0
--- /dev/null
+++ b/node_modules/memory-fs/README.md
@@ -0,0 +1,29 @@
+# memory-fs
+
+A simple in-memory filesystem. Holds data in a javascript object.
+
+``` javascript
+var MemoryFileSystem = require("memory-fs");
+var fs = new MemoryFileSystem(); // Optionally pass a javascript object
+
+fs.mkdirpSync("/a/test/dir");
+fs.writeFileSync("/a/test/dir/file.txt", "Hello World");
+fs.readFileSync("/a/test/dir/file.txt"); // returns Buffer("Hello World")
+
+// Async variants too
+fs.unlink("/a/test/dir/file.txt", function(err) {
+ // ...
+});
+
+fs.readdirSync("/a/test"); // returns ["dir"]
+fs.statSync("/a/test/dir").isDirectory(); // returns true
+fs.rmdirSync("/a/test/dir");
+
+fs.mkdirpSync("C:\\use\\windows\\style\\paths");
+```
+
+## License
+
+Copyright (c) 2012-2014 Tobias Koppers
+
+MIT (http://www.opensource.org/licenses/mit-license.php)