This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

Clean up posix module docs

  • Loading branch information...
1 parent c536728 commit 7b2fdc098b518d1f182e3ac1581018a0d22e4606 @ry ry committed Oct 29, 2009
Showing with 10 additions and 8 deletions.
  1. +10 −8 doc/api.txt
View
@@ -470,13 +470,16 @@ File I/O is provided by simple wrappers around standard POSIX functions. To
use this module do +require("/posix.js")+.
All POSIX wrappers have a similar form. They return a promise
-(+node.Promise+). Example:
+(+node.Promise+). Example of deleting a file:
------------------------------------------------------------------------------
-var posix = require("/posix.js");
+var posix = require("/posix.js"),
+ sys = require("/sys.js");
+
var promise = posix.unlink("/tmp/hello");
+
promise.addCallback(function () {
- puts("successfully deleted /tmp/hello");
+ sys.puts("successfully deleted /tmp/hello");
});
------------------------------------------------------------------------------
@@ -486,7 +489,7 @@ following is very much prone to error
------------------------------------------------------------------------------
posix.rename("/tmp/hello", "/tmp/world");
posix.stat("/tmp/world").addCallback(function (stats) {
- puts("stats: " + JSON.stringify(stats));
+ sys.puts("stats: " + JSON.stringify(stats));
});
------------------------------------------------------------------------------
@@ -496,7 +499,7 @@ The correct way to do this is to chain the promises.
------------------------------------------------------------------------------
posix.rename("/tmp/hello", "/tmp/world").addCallback(function () {
posix.stat("/tmp/world").addCallback(function (stats) {
- puts("stats: " + JSON.stringify(stats));
+ sys.puts("stats: " + JSON.stringify(stats));
});
});
------------------------------------------------------------------------------
@@ -505,9 +508,8 @@ Or use the +promise.wait()+ functionality:
------------------------------------------------------------------------------
posix.rename("/tmp/hello", "/tmp/world").wait();
-posix.stat("/tmp/world").addCallback(function (stats) {
- puts("stats: " + JSON.stringify(stats));
-});
+var stats = posix.stat("/tmp/world").wait();
+sys.puts("stats: " + JSON.stringify(stats));
------------------------------------------------------------------------------
+posix.rename(path1, path2)+ ::

0 comments on commit 7b2fdc0

Please sign in to comment.