Commit Graph
134 Commits
Author SHA1 Message Date
David Trejo f4e69e44ff readline docs 2011-05-18 21:13:49 -07:00
isaacs 249361cab7 Close #1054 More clear documentation for module system 2011-05-16 23:30:43 +02:00
koichik 56aa2fd4c3 Fix doc - missing dns.resolveNs() and dns.resolveCname()
Fixes #1039.
2011-05-14 14:36:58 -07:00
Felix Geisendörfer 9d717f6bef Update http.ServerRequest docs
The documentation for 'end' was wrong, and 'close' now has an `err`
parameter.
2011-05-14 14:21:41 -07:00
Ryan Dahl 11beac70e2 Docs: server.pause() server.address() socket.address() 2011-05-09 10:49:27 -07:00
Trevor Burnham 31ed87b0a9 Documenting require.main, fixing #997 2011-05-09 10:29:09 -07:00
Ryan Dahl ad487d3226 Add on('error') to http request example
for indexzero
2011-05-05 15:40:55 -07:00
koichik 1343ee8d54 Doc improvements. 2011-04-28 04:54:28 -04:00
George Miroshnykov 68c8a69f4c Close #962: Fixed typo in vm.runInNewContext docs.
EDIT: Also added another typo fix to this commit. --isaacs
2011-04-25 13:45:58 -07:00
Ryan Dahl d3d35ec3ca add docs for console object 2011-04-18 16:52:53 -07:00
Ryan Dahl ed316ae350 Docs: some encodings contains multibyte chars.
fixes #888
2011-04-14 15:11:35 -07:00
koichik 74d94b0dd1 Fix docs - Move module's description to right position 2011-04-14 14:40:50 -07:00
Felix Geisendörfer 301f53c2aa Allow omission of end option for range reads
Problem: Sometimes it is useful to read a file from a certain position
to it's end. The current implementation was already perfectly capable
of this, but decided to throw an error when the user tried to omit
the end option. The only way to do this, was to pass {end: Infinity}.

Solution: Automatically assume {end: Infinity} when omitted, and remove
the previous exception thrown. Also updated the docs.

closes #801.
2011-04-13 09:46:28 -07:00
Ryan Dahl af96447016 Modify text about buffer.write and partial chars
Fixes GH-913.
2011-04-13 01:27:00 -07:00
Ryan Dahl 9b3b37e498 Add docs about Buffer._charsWritten
Fixes GH-907.
2011-04-12 15:21:04 -07:00
Ryan Dahl 0f47f63746 Fix doc - no setBodyEnocoding anymore
Thanks Frederic. Closes GH-859.
2011-04-11 17:30:36 -07:00
koichik ca028f4b37 Fix docs: There were 2 descriptions of 'request' event. 2011-04-11 17:27:24 -07:00
Ryan Dahl d2298d225c Add documentation around module.exports and scope of global objects
Closes GH-852.
2011-04-11 17:01:25 -07:00
Ryan Dahl dcc2dd5e1f Add example to sha1 docs 2011-04-03 01:09:00 -07:00
George Stagas 3002c01f40 Changed script to vm and corrected order to match index 2011-04-02 02:35:44 -07:00
Ryan Dahl ffb3ee6084 Remove reference to CommonJS in documentation 2011-04-01 22:18:23 -07:00
Ryan Dahl 4877279efa Add timers to globals section
Closes GH-864.
2011-04-01 09:19:08 -07:00
Jorge Chamorro Bieling e35b2d9617 docs: fs.read/write() cb()s now receive buffer 2011-03-29 12:23:42 -07:00
Ryan Dahl 1768c72135 Add doc note about STARTTLS 2011-03-29 09:58:50 -07:00
Ryan Dahl 98b56636c0 Revert "Alphabetize the table of contents for the API docs"
This reverts commit a66e45693c.
2011-03-28 17:36:50 -07:00
Ryan Dahl e9a1dd7930 Typo in docs
Thanks to Anatoliy Chakkaev for pointing it out.

Closes GH-841.
2011-03-28 15:59:43 -07:00
Brian White a66e45693c Alphabetize the table of contents for the API docs 2011-03-28 15:56:39 -07:00
Ryan Dahl 2f2c9d47fd Remove strange unicode output in docs 2011-03-28 15:55:45 -07:00
David Trejo 6788ad413f See the <doc> section are now links to <doc>
Closes GH-839.
2011-03-28 15:53:17 -07:00
Ryan Dahl 978a50c500 Remove exterraneous line 2011-03-28 15:46:36 -07:00
Ryan Dahl 69c3e1961b Remove asciiSlice from docs 2011-03-23 15:02:11 -07:00
Zachary Scott 2b2736153d clean up whitespace in examples 2011-03-22 14:39:30 -07:00
Zachary Scott 67913a0232 writable stream api has destroySoon() for exiting after data queue has been drained 2011-03-22 14:38:59 -07:00
Trevor Burnham 5e78f57087 Doc fix for fs.write
Closes GH-808
Closes GH-811
2011-03-22 14:34:25 -07:00
Trevor Burnham f0d0fcc4aa Clarifying that writeFile replaces existing file 2011-03-22 14:33:23 -07:00
Trevor Burnham 3ec391ba36 Correcting typo in docs: 'deprecated', not 'depreciated' 2011-03-22 14:33:23 -07:00
koichik 5ccdff48f3 Document 'ucs2' encoding for Buffer 2011-03-18 11:23:37 -07:00
Ryan Dahl 9a8e843ca3 Document options for https.request
Closes GH-768.
2011-03-10 13:34:50 -08:00
koichik 4e047d32b0 Document net.Socket() constructor 2011-03-10 10:57:47 -08:00
koichik db6ea10948 Correct some links 2011-03-07 10:17:54 -08:00
koichik 07426ef29c Document allowHalfOpen for net.createServer() 2011-03-07 10:17:22 -08:00
koichik 452df69964 Correct net.createServer() API docs 2011-03-02 12:10:36 -08:00
isaacs 3599c71dae Closes GH-690 node_modules folders should be highest priority 2011-02-27 17:14:16 -08:00
Ryan Dahl 839fb8e19b typos 2011-02-24 16:36:43 -08:00
Felix Geisendörfer 2680522d3a Fix ReadStream bufferSize docs
The default is 64kb buffer, not 4kb.

Closes GH-702.
2011-02-24 12:46:17 -08:00
Felix Geisendörfer 06ac129903 Document existence of fd property for ReadStream
Closes GH-194.
Closes GH-701.
2011-02-24 12:44:21 -08:00
Ryan Dahl 45adc907c9 ry/node -> joyent/node 2011-02-23 16:38:34 -08:00
Ryan Dahl 47f5fd01e1 Add example to TTY documentation 2011-02-20 13:53:40 -08:00
Ryan Dahl df215a67d4 Document path.existsSync()
Closes GH-677.
2011-02-20 13:11:55 -08:00
Felix Geisendörfer aabdd5d045 Correct fs.open API documentation
The fact that the mode parameter is optional for fs.open and
fs.openSync was not documented.
2011-02-15 13:57:41 -08:00