mirrors/nodejs
mirrors/nodejs
0
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-11-30 07:27:22 +01:00
Code Issues Releases Activity
e7a2367471
nodejs/doc/api/_toc.md

63 lines
1.6 KiB
Markdown
Raw Normal View History

doc: add new documentation lint rule Add 80 characters limit to docs. Change docs to fit 80 characters per row. PR-URL: https://github.com/nodejs/node/pull/18726 Fixes: https://github.com/nodejs/node/issues/18703 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
2018-02-12 08:31:55 +01:00
@// NB(chrisdickinson): if you move this file, be sure to update
@// tools/doc/html.js to point at the new location.
doc: add introduced_in metadata to _toc.md Allow users to switch to the table of contents for older versions of Node.js. This gets rid of the "Failed to add alternative version link" warnings when building docs. PR-URL: https://github.com/nodejs/node/pull/19113 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Matheus Marchini <matheus@sthima.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2018-03-04 01:14:06 +01:00
<!--introduced_in=v0.10.0-->
Add 'about these docs' section
2012-02-27 20:06:14 +01:00
* [About these Docs](documentation.html)
doc: better example & synopsis PR-URL: https://github.com/nodejs/node/pull/6167 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Robert Jefe Lindstädt <robert.lindstaedt@gmail.com>
2016-04-12 19:25:03 +02:00
* [Usage & Example](synopsis.html)
doc: subdivide TOC, add auxiliary links PR-URL: https://github.com/nodejs/node/pull/6167 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Robert Jefe Lindstädt <robert.lindstaedt@gmail.com>
2016-04-12 19:26:21 +02:00
<div class="line"></div>
doc: put API table of contents in alphabetical order
2012-09-23 00:48:47 +02:00
* [Assertion Testing](assert.html)
doc: add async_hooks, n-api to _toc.md and all.md PR-URL: https://github.com/nodejs/node/pull/13379 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-06-02 00:01:18 +02:00
* [Async Hooks](async_hooks.html)
s/buffers/buffer/
2012-02-27 20:12:35 +01:00
* [Buffer](buffer.html)
doc: clarify node.js addons are c++ PR-URL: https://github.com/nodejs/node/pull/12898 Fixes: https://github.com/nodejs/node/issues/7129 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2017-05-08 11:36:41 +02:00
* [C++ Addons](addons.html)
doc: Add initial documentation for N-API Add the initial documentation for the N-API This PR is a result of work in the abi-stable-node repo: https://github.com/nodejs/abi-stable-node/tree/doc, with this PR being the cumulative work on the documentation sections in that repo with the following contributors in alphabetical order: Author: Arunesh Chandra <arunesh.chandra@microsoft.com> Author: Gabriel Schulhof <gabriel.schulhof@intel.com> Author: Hitesh Kanwathirtha <hiteshk@microsoft.com> Author: Jason Ginchereau <jasongin@microsoft.com> Author: Michael Dawson <michael_dawson@ca.ibm.com> Author: Sampson Gao <sampsong@ca.ibm.com> Author: Taylor Woll <taylor.woll@microsoft.com> PR-URL: https://github.com/nodejs/node/pull/12549 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2017-04-20 00:26:24 +02:00
* [C/C++ Addons - N-API](n-api.html)
doc: put API table of contents in alphabetical order
2012-09-23 00:48:47 +02:00
* [Child Processes](child_process.html)
* [Cluster](cluster.html)
doc: add a cli options doc page This page is mostly a mirror of the updated manual page. PR-URL: https://github.com/nodejs/node/pull/5787 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell jasnell@gmail.com> Reviewed-By: Bryan English <bryan@bryanenglish.com> Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com>
2016-03-18 18:26:41 +01:00
* [Command Line Options](cli.html)
doc: call console module 'console' not 'stdio' The console module has always been called 'stdio' in the table-of-contents, but nowhere else, since its name is 'console'. This makes it difficult to find.
2013-06-12 01:49:56 +02:00
* [Console](console.html)
Revert "Alphabetize the table of contents for the API docs" This reverts commit a66e45693ce19345cbe819e077340a882d67c5c8.
2011-03-29 02:36:50 +02:00
* [Crypto](crypto.html)
doc: put API table of contents in alphabetical order
2012-09-23 00:48:47 +02:00
* [Debugger](debugger.html)
lib: add static identifier codes for all deprecations Assigns a static identifier code to all runtime and documentation only deprecations. The identifier code is included in the emitted DeprecationWarning. Also adds a deprecations.md to the API docs to provide a central location where deprecation codes can be referenced and explained. PR-URL: https://github.com/nodejs/node/pull/10116 Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Michal Zasso <targos@protonmail.com> Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>
2016-12-04 21:47:01 +01:00
* [Deprecated APIs](deprecations.html)
Revert "Alphabetize the table of contents for the API docs" This reverts commit a66e45693ce19345cbe819e077340a882d67c5c8.
2011-03-29 02:36:50 +02:00
* [DNS](dns.html)
doc: put API table of contents in alphabetical order
2012-09-23 00:48:47 +02:00
* [Domain](domain.html)
doc: add ESM doc to _toc.md and all.md PR-URL: https://github.com/nodejs/node/pull/15248 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-09-07 22:53:11 +02:00
* [ECMAScript Modules](esm.html)
doc: add error documentation PR-URL: https://github.com/iojs/io.js/pull/789 Reviewed-by: Rod Vagg <rod@vagg.org> Reviewed-By: Trevor Norris <trev.norris@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2015-02-10 21:48:55 +01:00
* [Errors](errors.html)
doc: put API table of contents in alphabetical order
2012-09-23 00:48:47 +02:00
* [Events](events.html)
* [File System](fs.html)
* [Globals](globals.html)
Splitting documentation
2010-10-28 14:18:16 +02:00
* [HTTP](http.html)
http2: introducing HTTP/2 At long last: The initial *experimental* implementation of HTTP/2. This is an accumulation of the work that has been done in the nodejs/http2 repository, squashed down to a couple of commits. The original commit history has been preserved in the nodejs/http2 repository. This PR introduces the nghttp2 C library as a new dependency. This library provides the majority of the HTTP/2 protocol implementation, with the rest of the code here providing the mapping of the library into a usable JS API. Within src, a handful of new node_http2_*.c and node_http2_*.h files are introduced. These provide the internal mechanisms that interface with nghttp and define the `process.binding('http2')` interface. The JS API is defined within `internal/http2/*.js`. There are two APIs provided: Core and Compat. The Core API is HTTP/2 specific and is designed to be as minimal and as efficient as possible. The Compat API is intended to be as close to the existing HTTP/1 API as possible, with some exceptions. Tests, documentation and initial benchmarks are included. The `http2` module is gated by a new `--expose-http2` command line flag. When used, `require('http2')` will be exposed to users. Note that there is an existing `http2` module on npm that would be impacted by the introduction of this module, which is the main reason for gating this behind a flag. When using `require('http2')` the first time, a process warning will be emitted indicating that an experimental feature is being used. To run the benchmarks, the `h2load` tool (part of the nghttp project) is required: `./node benchmarks/http2/simple.js benchmarker=h2load`. Only two benchmarks are currently available. Additional configuration options to enable verbose debugging are provided: ``` $ ./configure --debug-http2 --debug-nghttp2 $ NODE_DEBUG=http2 ./node ``` The `--debug-http2` configuration option enables verbose debug statements from the `src/node_http2_*` files. The `--debug-nghttp2` enables the nghttp library's own verbose debug output. The `NODE_DEBUG=http2` enables JS-level debug output. The following illustrates as simple HTTP/2 server and client interaction: (The HTTP/2 client and server support both plain text and TLS connections) ```jt client = http2.connect('http://localhost:80'); const req = client.request({ ':path': '/some/path' }); req.on('data', (chunk) => { /* do something with the data */ }); req.on('end', () => { client.destroy(); }); // Plain text (non-TLS server) const server = http2.createServer(); server.on('stream', (stream, requestHeaders) => { stream.respond({ ':status': 200 }); stream.write('hello '); stream.end('world'); }); server.listen(80); ``` ```js const http2 = require('http2'); const client = http2.connect('http://localhost'); ``` Author: Anna Henningsen <anna@addaleax.net> Author: Colin Ihrig <cjihrig@gmail.com> Author: Daniel Bevenius <daniel.bevenius@gmail.com> Author: James M Snell <jasnell@gmail.com> Author: Jun Mukai Author: Kelvin Jin Author: Matteo Collina <matteo.collina@gmail.com> Author: Robert Kowalski <rok@kowalski.gd> Author: Santiago Gimeno <santiago.gimeno@gmail.com> Author: Sebastiaan Deckers <sebdeckers83@gmail.com> Author: Yosuke Furukawa <yosuke.furukawa@gmail.com> PR-URL: https://github.com/nodejs/node/pull/14239 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2017-07-17 19:17:16 +02:00
* [HTTP/2](http2.html)
Add https docs to toc
2011-01-22 03:16:56 +01:00
* [HTTPS](https.html)
inspector: JavaScript bindings for the inspector PR-URL: https://github.com/nodejs/node/pull/12263 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: Josh Gavant <josh.gavant@outlook.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2016-12-13 02:08:31 +01:00
* [Inspector](inspector.html)
doc: add documentation on ICU PR-URL: https://github.com/nodejs/node/pull/13916 Refs: https://github.com/nodejs/node/pull/13644#discussion_r121616327 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2017-06-26 07:05:49 +02:00
* [Internationalization](intl.html)
doc: put API table of contents in alphabetical order
2012-09-23 00:48:47 +02:00
* [Modules](modules.html)
* [Net](net.html)
* [OS](os.html)
* [Path](path.html)
perf_hooks: implementation of the perf timing API An initial implementation of the Performance Timing API for Node.js. This is the same Performance Timing API implemented by modern browsers with a number of Node.js specific properties. The User Timing mark() and measure() APIs are implemented, garbage collection timing, and node startup milestone timing. ```js const { performance } = require('perf_hooks'); performance.mark('A'); setTimeout(() => { performance.mark('B'); performance.measure('A to B', 'A', 'B'); const entry = performance.getEntriesByName('A to B', 'measure')[0]; console.log(entry.duration); }, 10000); ``` The implementation is at the native layer and makes use of uv_hrtime(). This should enable *eventual* integration with things like Tracing and Inspection. The implementation is extensible and should allow us to add new performance entry types as we go (e.g. for measuring i/o perf, etc). Documentation and a test are provided. PR-URL: https://github.com/nodejs/node/pull/14680 Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2017-08-08 00:53:24 +02:00
* [Performance Hooks](perf_hooks.html)
doc: put API table of contents in alphabetical order
2012-09-23 00:48:47 +02:00
* [Process](process.html)
docs: add punycode to TOC Refs #3301.
2012-05-26 06:56:41 +02:00
* [Punycode](punycode.html)
doc: put API table of contents in alphabetical order
2012-09-23 00:48:47 +02:00
* [Query Strings](querystring.html)
Splitting documentation
2010-10-28 14:18:16 +02:00
* [Readline](readline.html)
* [REPL](repl.html)
doc: put API table of contents in alphabetical order
2012-09-23 00:48:47 +02:00
* [Stream](stream.html)
* [String Decoder](string_decoder.html)
* [Timers](timers.html)
* [TLS/SSL](tls.html)
trace_events: adds a new trace_events api Removes the requirement to use `--trace-events-enabled` to enable trace events. Tracing is enabled automatically if there are any enabled categories. Adds a new `trace_events` module with an API for enabling/disabling trace events at runtime without a command line flag. ```js const trace_events = require('trace_events'); const categories = [ 'node.perf', 'node.async_hooks' ]; const tracing = trace_events.createTracing({ categories }); tracing.enable(); // do stuff tracing.disable(); ``` Multiple `Tracing` objects may exist and be enabled at any point in time. The enabled trace event categories is the union of all enabled `Tracing` objects and the `--trace-event-categories` flag. PR-URL: https://github.com/nodejs/node/pull/19803 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
2018-04-04 03:05:33 +02:00
* [Trace Events](tracing.html)
Revert "Alphabetize the table of contents for the API docs" This reverts commit a66e45693ce19345cbe819e077340a882d67c5c8.
2011-03-29 02:36:50 +02:00
* [TTY](tty.html)
doc: put API table of contents in alphabetical order
2012-09-23 00:48:47 +02:00
* [UDP/Datagram](dgram.html)
* [URL](url.html)
* [Utilities](util.html)
lib: reintroduce v8 module I introduced this module over a year ago in a pull request as the v8 module but it was quickly subsumed by the tracing module. The tracing module was recently removed again and that is why this commit introduces the v8 module again, including the new features it picked up commits d23ac0e and f8076c4. PR-URL: https://github.com/iojs/io.js/pull/131 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Christian Tellnes <christian@tellnes.no> Reviewed-By: Thorsten Lorenz <thlorenz@gmx.de> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
2014-12-09 22:57:48 +01:00
* [V8](v8.html)
doc: put API table of contents in alphabetical order
2012-09-23 00:48:47 +02:00
* [VM](vm.html)
worker: implement `MessagePort` and `MessageChannel` Implement `MessagePort` and `MessageChannel` along the lines of the DOM classes of the same names. `MessagePort`s initially support transferring only `ArrayBuffer`s. Thanks to Stephen Belanger for reviewing this change in its original form, to Benjamin Gruenbaum for reviewing the added tests in their original form, and to Olivia Hugger for reviewing the documentation in its original form. Refs: https://github.com/ayojs/ayo/pull/98 PR-URL: https://github.com/nodejs/node/pull/20876 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Shingo Inoue <leko.noor@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: John-David Dalton <john.david.dalton@gmail.com> Reviewed-By: Gus Caplan <me@gus.host>
2017-09-05 22:38:32 +02:00
* [Worker](worker.html)
add zlib module to doc index
2011-10-01 02:01:07 +02:00
* [ZLIB](zlib.html)
doc: subdivide TOC, add auxiliary links PR-URL: https://github.com/nodejs/node/pull/6167 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Robert Jefe Lindstädt <robert.lindstaedt@gmail.com>
2016-04-12 19:26:21 +02:00
<div class="line"></div>
* [GitHub Repo & Issue Tracker](https://github.com/nodejs/node)
doc: update http URLs to https in doc/api PR-URL: https://github.com/nodejs/node/pull/17263 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
2017-11-23 00:04:16 +01:00
* [Mailing List](https://groups.google.com/group/nodejs)
Copy Permalink