From 16185ae57e11024ba0d35586eb0550e14782bd2b Mon Sep 17 00:00:00 2001 From: Ryan Dahl Date: Tue, 15 Sep 2009 22:32:37 +0200 Subject: [PATCH] update doc for node.fs.write() --- doc/api.html | 13 ++++++------- doc/api.txt | 11 +++++------ doc/node.1 | 4 +--- 3 files changed, 12 insertions(+), 16 deletions(-) diff --git a/doc/api.html b/doc/api.html index 46b19e60d3..4641471a3f 100644 --- a/doc/api.html +++ b/doc/api.html @@ -827,15 +827,14 @@ on error: no parameters.
-node.fs.write(fd, data, position) +node.fs.write(fd, data, position, encoding)

- Write data to the file specified by fd. data is either an array of - integers (for raw data) or a string for UTF-8 encoded characters. - position refers to the offset from the beginning of the file where this - data should be written. If position is null, the data will be written at - the current position. See pwrite(2). + Write data to the file specified by fd. position refers to the offset + from the beginning of the file where this data should be written. If + position is null, the data will be written at the current position. + See pwrite(2).

  • @@ -1907,7 +1906,7 @@ init (Handle<Object> target) diff --git a/doc/api.txt b/doc/api.txt index d88bffc1b4..1209d51e59 100644 --- a/doc/api.txt +++ b/doc/api.txt @@ -503,12 +503,11 @@ node.fs.stat("/tmp/world").addCallback(function (stats) { - on error: no parameters. -+node.fs.write(fd, data, position)+:: - Write data to the file specified by +fd+. +data+ is either an array of - integers (for raw data) or a string for UTF-8 encoded characters. - +position+ refers to the offset from the beginning of the file where this - data should be written. If +position+ is +null+, the data will be written at - the current position. See pwrite(2). ++node.fs.write(fd, data, position, encoding)+:: + Write data to the file specified by +fd+. +position+ refers to the offset + from the beginning of the file where this data should be written. If + +position+ is +null+, the data will be written at the current position. + See pwrite(2). - on success: returns an integer +written+ which specifies how many _bytes_ were written. - on error: no parameters. diff --git a/doc/node.1 b/doc/node.1 index b9d465f689..c010440622 100644 --- a/doc/node.1 +++ b/doc/node.1 @@ -739,12 +739,10 @@ is given as the parameter\. .RE .RE .PP -node\.fs\.write(fd, data, position) +node\.fs\.write(fd, data, position, encoding) .RS 4 Write data to the file specified by fd\. -data -is either an array of integers (for raw data) or a string for UTF\-8 encoded characters\. position refers to the offset from the beginning of the file where this data should be written\. If position