Browse Source

Add doc note about 'raws' encoding

v0.7.4-release
Ryan 16 years ago
parent
commit
5629fd574a
  1. 14
      doc/api.html
  2. 12
      doc/api.txt
  3. 9
      doc/node.1

14
doc/api.html

@ -55,12 +55,12 @@ Server running at http://127.0.0.1:8000/</tt></pre>
</div> </div>
<h2 id="_api">API</h2> <h2 id="_api">API</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="paragraph"><p>Node supports 3 byte-string encodings: ASCII (<tt>"ascii"</tt>), UTF-8 (<tt>"utf8"</tt>), <div class="paragraph"><p>Node supports 4 byte-string encodings. ASCII (<tt>"ascii"</tt>), UTF-8 (<tt>"utf8"</tt>)
and raw binary (<tt>"raw"</tt>). It uses strings to represent ASCII and UTF-8 both use the string object, obviously. Then two "raw binary" encodings - one
encoded data. For the moment, arrays of integers are used to represent raw uses an array of integers (<tt>"raw"</tt>) and the other uses a string (<tt>"raws"</tt>).
binary data&#8212;this representation is rather inefficient. This will Neither raw encodings are perfect and thier implemenations are rather
change in the future, when inefficient. Hopefully the raw encoding situation will improve in the
<a href="http://code.google.com/p/v8/issues/detail?id=270">V8 supports Blob objects</a>.</p></div> future.</p></div>
<div class="paragraph"><p>Unless otherwise noted, functions are all asynchronous and do not block <div class="paragraph"><p>Unless otherwise noted, functions are all asynchronous and do not block
execution.</p></div> execution.</p></div>
<h3 id="_helpers">Helpers</h3><div style="clear:left"></div> <h3 id="_helpers">Helpers</h3><div style="clear:left"></div>
@ -1863,7 +1863,7 @@ init (Handle&lt;Object&gt; target)
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Version 0.1.9<br /> Version 0.1.9<br />
Last updated 2009-09-11 13:40:01 CEST Last updated 2009-09-11 20:58:54 CEST
</div> </div>
</div> </div>
</body> </body>

12
doc/api.txt

@ -38,12 +38,12 @@ Server running at http://127.0.0.1:8000/
== API == API
Node supports 3 byte-string encodings: ASCII (+"ascii"+), UTF-8 (+"utf8"+), Node supports 4 byte-string encodings. ASCII (+"ascii"+), UTF-8 (+"utf8"+)
and raw binary (+"raw"+). It uses strings to represent ASCII and UTF-8 both use the string object, obviously. Then two "raw binary" encodings - one
encoded data. For the moment, arrays of integers are used to represent raw uses an array of integers (+"raw"+) and the other uses a string (+"raws"+).
binary data--this representation is rather inefficient. This will Neither raw encodings are perfect and thier implemenations are rather
change in the future, when inefficient. Hopefully the raw encoding situation will improve in the
http://code.google.com/p/v8/issues/detail?id=270[V8 supports Blob objects]. future.
Unless otherwise noted, functions are all asynchronous and do not block Unless otherwise noted, functions are all asynchronous and do not block
execution. execution.

9
doc/node.1

@ -38,7 +38,7 @@ Server running at http://127\.0\.0\.1:8000/
.fi .fi
.RE .RE
.SH "API" .SH "API"
Node supports 3 byte\-string encodings: ASCII ("ascii"), UTF\-8 ("utf8"), and raw binary ("raw")\. It uses strings to represent ASCII and UTF\-8 encoded data\. For the moment, arrays of integers are used to represent raw binary data\(emthis representation is rather inefficient\. This will change in the future, when V8 supports Blob objects\. Node supports 4 byte\-string encodings\. ASCII ("ascii"), UTF\-8 ("utf8") both use the string object, obviously\. Then two "raw binary" encodings \- one uses an array of integers ("raw") and the other uses a string ("raws")\. Neither raw encodings are perfect and thier implemenations are rather inefficient\. Hopefully the raw encoding situation will improve in the future\.
.sp .sp
Unless otherwise noted, functions are all asynchronous and do not block execution\. Unless otherwise noted, functions are all asynchronous and do not block execution\.
.sp .sp
@ -1774,16 +1774,11 @@ Further documentation will come soon\. For now see the source code of node_postg
.sp .sp
.SH "NOTES" .SH "NOTES"
.IP " 1." 4 .IP " 1." 4
V8 supports Blob objects
.RS 4
\%http://code.google.com/p/v8/issues/detail?id=270
.RE
.IP " 2." 4
here here
.RS 4 .RS 4
\%http:/cvs.schmorp.de/libev/ev.html \%http:/cvs.schmorp.de/libev/ev.html
.RE .RE
.IP " 3." 4 .IP " 2." 4
node_postgres node_postgres
.RS 4 .RS 4
\%http://github.com/ry/node_postgres \%http://github.com/ry/node_postgres

Loading…
Cancel
Save