Ryan Graham
93391ae9cb
doc: clarify exports and module.exports
When exporting a single function you must use `module.exports` instead
of the `exports` convenience reference.
12 years ago
isaacs
dda7b40204
doc: Fix require.extensions documentation
1. The stability index must come first, or it messes up the markdown
2. require.extensions is an Object, not an Array.
Close #5387
12 years ago
isaacs
7bd8a5a2a6
doc: Deprecate require.extensions
12 years ago
Ben Noordhuis
c79fd0e167
doc: remove broken require.extensions example
Fixes #4384 .
12 years ago
Ben Noordhuis
b53cd9798f
doc: document setTimeout / setInterval behavior
13 years ago
Ben Kelly
c6185c8484
doc: Improve cross-linking in API docs markdown
Cross-link EventEmitter references in API docs to events.html
Fix broken cross-reference links with wrong anchor names in API docs.
13 years ago
Kyle Robinson Young
718aa505c4
doc: add require.extensions to globals
Closes #3028
13 years ago
isaacs
674416fbc9
s/buffers/buffer/
13 years ago
isaacs
a62ec4437b
doc refactor: globals
13 years ago
isaacs
f9e464f95a
s/buffers/buffer/
13 years ago
isaacs
af7314e190
doc refactor: globals
13 years ago
isaacs
1b5048b288
doc: refer to modules doc rather than src/node.js
13 years ago
Thomas Shinnick
4cf0ce5bb4
docs: typos and minor edits in several modules
Mostly quite minor edits. Those possibly of more interest are:
emitter.setMaxListeners(n)
That the limit is per event name for an emitter.
fs.readlink()
Not a path, but rather the symbolic link's string value, which
would be at best a partial path, certainly not a 'resolvedPath'
global.__filename
This may be "well-known" but this is a full path to the module
that referencing code is running in. It is not the main program's
path, unless you are in the main program. Each module knows only
its own path.
server.listen(port,...)
I actually needed this functionality... "gimme just _any_ next port"
stream.end()
stream.destroy()
Yeah, everybody knows what happens to the queued data, but let's
make it *really* explicit for the first readers.
14 years ago
koichik
3eb246485a
Doc improvements
14 years ago
AJ ONeal
eb7d762c55
Document that 'Buffer' is a global variable
14 years ago
AJ ONeal
8cc9ac0df2
added explanation of `exports`
Fixes #1075 .
14 years ago
Ryan Dahl
b96ae6674d
document require.cache
14 years ago
Ryan Dahl
d3d35ec3ca
add docs for console object
14 years ago
koichik
74d94b0dd1
Fix docs - Move module's description to right position
14 years ago
Ryan Dahl
d2298d225c
Add documentation around module.exports and scope of global objects
Closes GH-852.
14 years ago
Ryan Dahl
4877279efa
Add timers to globals section
Closes GH-864.
14 years ago
David Trejo
6788ad413f
See the <doc> section are now links to <doc>
Closes GH-839.
14 years ago
Ryan Dahl
86bf3309bf
docs: style
14 years ago
Ryan Dahl
a51063c13c
docs: Add note about global scope
14 years ago
isaacs
a2b3c865c9
Correct reference to "process.Module"
14 years ago
Micheil Smith
e190c9616e
Splitting documentation
14 years ago