Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc/api
AgeCommit message (Collapse)Author
2013-10-30doc: Update documentation to reflect ObjectWrap changesScott Blomquist
2013-10-29src: accept passphrase when crypto signing with private keyThom Seddon
Previous behaviour was to drop to an openssl prompt ("Enter PEM pass phrase:") when supplying a private key with a passphrase. This change adds a fourth, optional, paramter that will be used as the passphrase. To include this parameter in a backwards compatible way it was necessary to expose the previously undocumented (and unexposed) feature of being able to explitly setting the output encoding.
2013-10-29dgram: send() can accept stringsTrevor Norris
Strings passed to Socket#send() will be passed to Buffer and parsed as UTF8.
2013-10-29Merge remote-tracking branch 'ry/v0.10'isaacs
2013-10-28http: expose supported methodsBen Noordhuis
Expose the list of supported HTTP methods as a property on the 'http' module object. Fixes #6422.
2013-10-28doc: fs: clarify fs.symlink Windows specific argsPhillip Alexander
2013-10-27doc: improve module documentationRyan Graham
Expands on when to use module.exports vs. exports. This is a recurring question on mailing list and continues to confuse new devs.
2013-10-26doc: fix missing backtick in 2e16037Sam Roberts
2013-10-25Merge remote-tracking branch 'upstream/v0.10'Timothy J Fontaine
Conflicts: ChangeLog deps/uv/ChangeLog deps/uv/include/uv-darwin.h deps/uv/src/unix/fsevents.c deps/uv/src/unix/process.c deps/uv/src/version.c doc/api/addons.markdown doc/api/cluster.markdown doc/api/http.markdown lib/http.js lib/tls.js src/node_crypto.cc src/node_http_parser.cc src/node_version.h src/pipe_wrap.cc src/v8abbr.h src/v8ustack.d test/simple/test-http-pipeline-flood.js
2013-10-25doc: streams: document default objectMode settingBrian White
2013-10-17http: add statusMessagePatrik Stutz
Now the status message can be set via req.statusMessage = 'msg';
2013-10-17doc: cluster documentation cleanup and correctionsSam Roberts
- fixed some incomprehensible wording ("event assigned to..."?) - removed undocumented and unnecessary process properties from example - corrected the docs on the default for the exec setting - described when workers are removed from cluster.workers - described addressType, which was documented as existing, but not what values it might have - spell out more clearly the limitations of setupMaster - describe disconnect in sufficient detail that why a child does or does not exit can be understood - clarify which cluster functions and events are available on process or just on the worker, as well as which are not available in children, - don't describe events as the same, when they have receive different arguments - fix misleading disconnect example: since disconnect already calls close on all servers, doing it again in the example is a no-op, not the "force close" it was claimed to be - document the error event, not catching it will kill your node - describe suicide better, it is important, and a bit unintuitive (process.exit() is not suicide?) - use worker consistently throughout, instead of child.
2013-10-17doc: child_process corrections and cleanupsSam Roberts
- Make explicit that .disconnected is set before the disconnect event, and it is not allowed to send messages after calling .disconnect(), even while waiting for a delayed disconect event. - Remove obsolete claim that explicit exit is required - Describe silent: in the options for fork() - Describe .connected as the property it is, not just as an aside in the disconnect() method
2013-10-16dns: rename domain to hostnameBen Noordhuis
A follow-up commit will save the domain name on the request object but we can't call that property 'domain' because that gets intercepted by src/node.cc and lib/domain.js to implement the node.js feature of the same name. To avoid confusion, rename all variables called 'domain' to 'hostname'.
2013-10-16doc: crypto: document SPKAC additionsJason Gerfen
Document the SPKAC functionality that was added in commit 7bf46ba.
2013-10-16doc: http: reword IncomingMessage 'close' eventBen Noordhuis
The bit that says "before response.end() was called or able to flush" doesn't apply to incoming streams. Fixes #6359.
2013-10-16doc: http: add cross-links for easier clickingBen Noordhuis
Make it a little easier to navigate the http module documentation by turning class names and methods into links to the appropriate section.
2013-10-16Revert "doc: crypto: document SPKAC additions"isaacs
This reverts commit aa94450b31a28d6251df3b88fdd652ddd1e67a69.
2013-10-15doc: crypto: document SPKAC additionsJason Gerfen
Document the SPKAC functionality that was added in commit 7f66e44.
2013-10-15doc: expand os.loadavg() sectionBen Noordhuis
Add a short explanation of what the load average is and why it's unavailable on Windows. Also sneak in a fix for a typo that I introduced in commit 56c5806.
2013-10-14doc: document os.loadavg() behavior on windowsBen Noordhuis
The load average is a very UNIX-y concept. That's why os.loadavg() always returns zeros on Windows. Mention that in the documentation.
2013-10-11buffer: add buf.toArrayBuffer() APITrevor Norris
2013-10-10doc: net: remove bad net.Server descriptionBen Noordhuis
net.Server is not an instance of net.Socket so don't say it is.
2013-10-10doc: addon: fix object instantiation examplesBen Noordhuis
* Extend examples to show how to handle non-constructor invocation in constructor callback functions. * Fix up examples to initialize member variables at object construction. * Fix up a few naming inconsistencies. Fixes #5701.
2013-10-05doc: add warning to fs.exists() documentationBen Noordhuis
Warn against the open-if-exists anti-pattern, it's susceptible to race conditions.
2013-09-25Merge remote-tracking branch 'upstream/v0.10'Timothy J Fontaine
Conflicts: AUTHORS ChangeLog configure deps/uv/ChangeLog deps/uv/src/version.c lib/tls.js src/node_version.h
2013-09-19doc: document reserved status of SIGUSR1Ben Noordhuis
Fixes #1212.
2013-09-17doc: fix typos in the tls `NPNProtocols` optionNathan Rajlich
2013-09-17doc: specify the format of the `ca` tls optionNathan Rajlich
2013-09-07process: use exit 1 for uncaughtExceptionisaacs
Since it is Unix tradition to use exit code 1 for general-purpose script bail-out, and the way of doing that in Node is to throw an exception and not catch it, it makes the most sense to exit with 1 when an exception goes uncaught. Move the `Invalid Argument` exit to 9, so that it's something specific, and clear that it's a node internal error. Also, document the exit codes that we use.
2013-09-07process: Add exitCode propertyisaacs
This allows one to set a specific status code, while still letting the process exit gracefully once all async operations are completed.
2013-09-05tls: socket.renegotiate(options, callback)Fedor Indutny
This utility function allows renegotiaion of secure connection after establishing it. fix #2496
2013-09-05Merge remote-tracking branch 'upstream/v0.10'Timothy J Fontaine
Conflicts: ChangeLog src/node_version.h
2013-09-04stream: return this from pause()/resume()isaacs
2013-09-04doc: fix writable.write linkKyle Robinson Young
2013-08-29vm: document vm2's changes.Domenic Denicola
- The caveats no longer apply. - Document options arguments, including `displayErrors` and the different things it means in each place. - Re-did examples to be more on point, e.g. `runInContext` example runs multiple scripts in the same context. - Documented how `vm.createContext`s meaning has substantially changed, and is now more of a "contextifier" than a "creator." - Reordered vm functions to be readable in order; the concept of contextifying needs to come before `runInContext` and `runInNewContext`. - Documented new `vm.isContext`. - Documented the `vm.Script` constructor, instead of `createScript`, since factory methods are silly and we wanted to document the class's methods anyway. - Documented `script.runInContext`. - Change stability to stable, if I may be so bold.
2013-08-28doc: Adjust util stability index to 'API Frozen'isaacs
Closes #6087
2013-08-28doc: Adjust util stability index to 'API Frozen'isaacs
Closes #6087
2013-08-28doc: mark repl as stableisaacs
Closes #6090
2013-08-28stream: change default hwm for objectMode to 16Mathias Buus
2013-08-27domains: deprecate domain.dispose().Forrest L Norvell
Follows @isaacs's recommendations in joyent/node#5018. Includes some updates to documentation but not examples. Conflicts: lib/domain.js
2013-08-27fs: Expose birthtime on stat objectsisaacs
Just do the best we can with whatever libuv gives us. Also, document the semantics of `ctime` and the compatibility with Windows.
2013-08-23util: pass opts to custom inspect functionsTimothy J Fontaine
Objects with custom inpsect functions should get the options that were passed to `util.inspect()` fixes #5822 fixes #6098
2013-08-21Merge remote-tracking branch 'ry/v0.10'isaacs
Conflicts: lib/tls.js
2013-08-20net: family option in net.connectVsevolod Strukchinsky
`dns.lookup` defaults to selecting IPv4 record even if IPv6 is available for the desired zone. Generally, this approach works, but if IPv4 address is unavailable - there'll be no other way to opt-out and connect using IPv6 address than calling `dns.lookup` and passing it to `.connect()` directly. This commit adds `family` option to `net.connect` method to figure out this issue.
2013-08-20doc: Minor typos in dgram docisaacs
a/an usage. Thanks @KenanSulayman
2013-08-20doc: Add callback parameter to dgram socket.bind()Duan Yao
Also, describe more details of bind().
2013-08-20doc: fixed syntax error in stream.TransformChrisWren
2013-08-20Added documentation for process.execArgvEdward Hutchins
2013-08-20doc: add missing word in Transform stream introEivind Uggedal