Add examples of reading a file to documentation.

pull/5370/head
Ryan 2009-07-31 19:56:53 +02:00
parent 4f46c47773
commit c745383b31
1 changed files with 25 additions and 0 deletions

View File

@ -482,6 +482,19 @@ or +node.RAW+.
- on success: returns +data, bytes_read+, what was read from the file.
- on error: no parameters.
+node.fs.cat(filename, encoding)+::
Outputs the entire contents of a file. Example:
+
--------------------------------
node.fs.cat("/etc/passwd", "utf8").addCallback(function (content) {
puts(content);
});
--------------------------------
+
- on success: returns +data+, what was read from the file.
- on error: no parameters.
==== +node.fs.File+
@ -498,6 +511,18 @@ file.write("world");
file.close();
----------------------------------------
Here is an example of reading the first 10 bytes from +/etc/passwd+ and
outputting it to +stdout+.
----------------------------------------
var file = new node.fs.File({encoding: "utf8"});
file.open("/etc/passwd", "r");
file.read(10).addCallback(function (chunk) {
puts(chunk);
});
file.close();
----------------------------------------
[cols="1,2,10",options="header"]
|=========================================================
|Event |Parameters | Notes