From 7b2fdc098b518d1f182e3ac1581018a0d22e4606 Mon Sep 17 00:00:00 2001 From: Ryan Dahl Date: Thu, 29 Oct 2009 11:17:26 +0100 Subject: [PATCH] Clean up posix module docs --- doc/api.txt | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/doc/api.txt b/doc/api.txt index b56324635d1..9f0c79d566e 100644 --- a/doc/api.txt +++ b/doc/api.txt @@ -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)+ ::