diff options
author | Alec Davidson <davidson9076@gmail.com> | 2020-06-22 20:56:08 +0300 |
---|---|---|
committer | Myles Borins <mylesborins@github.com> | 2020-07-17 00:08:55 +0300 |
commit | eb04ba3080704e76398a293c331b8de09b10a558 (patch) | |
tree | a231bc012f617c3a4910feb902fa77ec538677cf /doc | |
parent | 2ca6a45ba9d38209c342bbd1064e9d2b400e34f0 (diff) |
doc: add dynamic source code links
Fixes: https://github.com/nodejs/node/pull/33977
PR-URL: https://github.com/nodejs/node/pull/33996
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
38 files changed, 76 insertions, 0 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md index 9ad01a48f0f..0f88c1829d1 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/assert.js --> + The `assert` module provides a set of assertion functions for verifying invariants. diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index 49aac3dc445..b3aec8cce45 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -4,6 +4,8 @@ > Stability: 1 - Experimental +<!-- source_link=lib/async_hooks.js --> + The `async_hooks` module provides an API to track asynchronous resources. It can be accessed using: diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 2df4fe79508..719af1ba7f5 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/buffer.js --> + In Node.js, `Buffer` objects are used to represent binary data in the form of a sequence of bytes. Many Node.js APIs, for example streams and file system operations, support `Buffer`s, as interactions with the operating system or diff --git a/doc/api/child_process.md b/doc/api/child_process.md index 779542c00fe..49b972362d4 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/child_process.js --> + The `child_process` module provides the ability to spawn child processes in a manner that is similar, but not identical, to popen(3). This capability is primarily provided by the [`child_process.spawn()`][] function: diff --git a/doc/api/cluster.md b/doc/api/cluster.md index 3c67d4cf1ed..1ed5e38670f 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/cluster.js --> + A single instance of Node.js runs in a single thread. To take advantage of multi-core systems, the user will sometimes want to launch a cluster of Node.js processes to handle the load. diff --git a/doc/api/console.md b/doc/api/console.md index 2f4a8e64ed5..ffc8825a46c 100644 --- a/doc/api/console.md +++ b/doc/api/console.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/console.js --> + The `console` module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers. diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 016a60802c4..28483b61ab6 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/crypto.js --> + The `crypto` module provides cryptographic functionality that includes a set of wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign, and verify functions. diff --git a/doc/api/dgram.md b/doc/api/dgram.md index 8e8f06551b7..be0323a306b 100644 --- a/doc/api/dgram.md +++ b/doc/api/dgram.md @@ -6,6 +6,8 @@ <!-- name=dgram --> +<!-- source_link=lib/dgram.js --> + The `dgram` module provides an implementation of UDP datagram sockets. ```js diff --git a/doc/api/dns.md b/doc/api/dns.md index 8a4ee45fe10..4f5133fea56 100644 --- a/doc/api/dns.md +++ b/doc/api/dns.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/dns.js --> + The `dns` module enables name resolution. For example, use it to look up IP addresses of host names. diff --git a/doc/api/domain.md b/doc/api/domain.md index b9219fbb4d7..109e41f749f 100644 --- a/doc/api/domain.md +++ b/doc/api/domain.md @@ -16,6 +16,8 @@ changes: > Stability: 0 - Deprecated +<!-- source_link=lib/domain.js --> + **This module is pending deprecation**. Once a replacement API has been finalized, this module will be fully deprecated. Most end users should **not** have cause to use this module. Users who absolutely must have diff --git a/doc/api/events.md b/doc/api/events.md index 80e9ccf6fef..d6aab8feab1 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -6,6 +6,8 @@ <!--type=module--> +<!-- source_link=lib/events.js --> + Much of the Node.js core API is built around an idiomatic asynchronous event-driven architecture in which certain kinds of objects (called "emitters") emit named events that cause `Function` objects ("listeners") to be called. diff --git a/doc/api/fs.md b/doc/api/fs.md index 317a1ca174c..d20e1901ae3 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -6,6 +6,8 @@ <!--name=fs--> +<!-- source_link=lib/fs.js --> + The `fs` module provides an API for interacting with the file system in a manner closely modeled around standard POSIX functions. diff --git a/doc/api/http.md b/doc/api/http.md index e8b12ae2357..b523f7453f1 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/http.js --> + To use the HTTP server and client one must `require('http')`. The HTTP interfaces in Node.js are designed to support many features diff --git a/doc/api/http2.md b/doc/api/http2.md index 67bb4c27e4d..4b3fc33b705 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -10,6 +10,8 @@ changes: > Stability: 2 - Stable +<!-- source_link=lib/http2.js --> + The `http2` module provides an implementation of the [HTTP/2][] protocol. It can be accessed using: diff --git a/doc/api/https.md b/doc/api/https.md index 96f21930f4a..2f362d40cf7 100644 --- a/doc/api/https.md +++ b/doc/api/https.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/https.js --> + HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a separate module. diff --git a/doc/api/inspector.md b/doc/api/inspector.md index 4f9501a5f86..f541b9eb99f 100644 --- a/doc/api/inspector.md +++ b/doc/api/inspector.md @@ -4,6 +4,8 @@ > Stability: 1 - Experimental +<!-- source_link=lib/inspector.js --> + The `inspector` module provides an API for interacting with the V8 inspector. It can be accessed using: diff --git a/doc/api/net.md b/doc/api/net.md index 6fedabf0d2c..860d2171839 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -5,6 +5,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/net.js --> + The `net` module provides an asynchronous network API for creating stream-based TCP or [IPC][] servers ([`net.createServer()`][]) and clients ([`net.createConnection()`][]). diff --git a/doc/api/os.md b/doc/api/os.md index a6c83e0206f..83681cdedfa 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/os.js --> + The `os` module provides operating system-related utility methods and properties. It can be accessed using: diff --git a/doc/api/path.md b/doc/api/path.md index 8349bce252a..14acbb1eb5f 100644 --- a/doc/api/path.md +++ b/doc/api/path.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/path.js --> + The `path` module provides utilities for working with file and directory paths. It can be accessed using: diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md index 8d540491604..759c141a2c7 100644 --- a/doc/api/perf_hooks.md +++ b/doc/api/perf_hooks.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/perf_hooks.js --> + This module provides an implementation of a subset of the W3C [Web Performance APIs][] as well as additional APIs for Node.js-specific performance measurements. diff --git a/doc/api/process.md b/doc/api/process.md index eda3ac16f7a..b2c0b483f83 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -3,6 +3,8 @@ <!-- introduced_in=v0.10.0 --> <!-- type=global --> +<!-- source_link=lib/process.js --> + The `process` object is a `global` that provides information about, and control over, the current Node.js process. As a global, it is always available to Node.js applications without using `require()`. It can also be explicitly diff --git a/doc/api/punycode.md b/doc/api/punycode.md index 4c9dc3460a0..bcdfb9a167f 100644 --- a/doc/api/punycode.md +++ b/doc/api/punycode.md @@ -10,6 +10,8 @@ changes: > Stability: 0 - Deprecated +<!-- source_link=lib/punycode.js --> + **The version of the punycode module bundled in Node.js is being deprecated**. In a future major version of Node.js this module will be removed. Users currently depending on the `punycode` module should switch to using the diff --git a/doc/api/querystring.md b/doc/api/querystring.md index 0797e3ee220..03ee78aad0a 100644 --- a/doc/api/querystring.md +++ b/doc/api/querystring.md @@ -6,6 +6,8 @@ <!--name=querystring--> +<!-- source_link=lib/querystring.js --> + The `querystring` module provides utilities for parsing and formatting URL query strings. It can be accessed using: diff --git a/doc/api/readline.md b/doc/api/readline.md index a737e4bd24d..d34ca6e91e7 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/readline.js --> + The `readline` module provides an interface for reading data from a [Readable][] stream (such as [`process.stdin`][]) one line at a time. It can be accessed using: diff --git a/doc/api/repl.md b/doc/api/repl.md index 4940001a4eb..56dc29fcec8 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/repl.js --> + The `repl` module provides a Read-Eval-Print-Loop (REPL) implementation that is available both as a standalone program or includible in other applications. It can be accessed using: diff --git a/doc/api/stream.md b/doc/api/stream.md index 7afa52c2f95..749593f92c7 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/stream.js --> + A stream is an abstract interface for working with streaming data in Node.js. The `stream` module provides an API for implementing the stream interface. diff --git a/doc/api/string_decoder.md b/doc/api/string_decoder.md index 5cd6121d50d..59056b86132 100644 --- a/doc/api/string_decoder.md +++ b/doc/api/string_decoder.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/string_decoder.js --> + The `string_decoder` module provides an API for decoding `Buffer` objects into strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16 characters. It can be accessed using: diff --git a/doc/api/timers.md b/doc/api/timers.md index 8b080b16ffb..1157ae286e0 100644 --- a/doc/api/timers.md +++ b/doc/api/timers.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/timers.js --> + The `timer` module exposes a global API for scheduling functions to be called at some future period of time. Because the timer functions are globals, there is no need to call `require('timers')` to use the API. diff --git a/doc/api/tls.md b/doc/api/tls.md index 71c127ca6cc..0fd84e198ac 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/tls.js --> + The `tls` module provides an implementation of the Transport Layer Security (TLS) and Secure Socket Layer (SSL) protocols that is built on top of OpenSSL. The module can be accessed using: diff --git a/doc/api/tracing.md b/doc/api/tracing.md index 907fc2bbe23..9350e0b9ca9 100644 --- a/doc/api/tracing.md +++ b/doc/api/tracing.md @@ -4,6 +4,8 @@ > Stability: 1 - Experimental +<!-- source_link=lib/trace_events.js --> + The `trace_events` module provides a mechanism to centralize tracing information generated by V8, Node.js core, and userspace code. diff --git a/doc/api/tty.md b/doc/api/tty.md index b1b1ebdb267..f4a83c290a3 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/tty.js --> + The `tty` module provides the `tty.ReadStream` and `tty.WriteStream` classes. In most cases, it will not be necessary or possible to use this module directly. However, it can be accessed using: diff --git a/doc/api/url.md b/doc/api/url.md index fbe8aa39791..06b80a438ad 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/url.js --> + The `url` module provides utilities for URL resolution and parsing. It can be accessed using: diff --git a/doc/api/util.md b/doc/api/util.md index 7b3d08e0a0b..3887de8e389 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/util.js --> + The `util` module supports the needs of Node.js internal APIs. Many of the utilities are useful for application and module developers as well. To access it: diff --git a/doc/api/v8.md b/doc/api/v8.md index 531612330f0..921c4378199 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -2,6 +2,8 @@ <!--introduced_in=v4.0.0--> +<!-- source_link=lib/v8.js --> + The `v8` module exposes APIs that are specific to the version of [V8][] built into the Node.js binary. It can be accessed using: diff --git a/doc/api/vm.md b/doc/api/vm.md index 7ef5ff62279..773173085cc 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -6,6 +6,8 @@ <!--name=vm--> +<!-- source_link=lib/vm.js --> + The `vm` module enables compiling and running code within V8 Virtual Machine contexts. **The `vm` module is not a security mechanism. Do not use it to run untrusted code**. diff --git a/doc/api/wasi.md b/doc/api/wasi.md index b46aacfbcb1..46673af9e7f 100644 --- a/doc/api/wasi.md +++ b/doc/api/wasi.md @@ -4,6 +4,8 @@ > Stability: 1 - Experimental +<!-- source_link=lib/wasi.js --> + The WASI API provides an implementation of the [WebAssembly System Interface][] specification. WASI gives sandboxed WebAssembly applications access to the underlying operating system via a collection of POSIX-like functions. diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 45b9a5f0fd2..26fb12be929 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/worker_threads.js --> + The `worker_threads` module enables the use of threads that execute JavaScript in parallel. To access it: diff --git a/doc/api/zlib.md b/doc/api/zlib.md index d5079266484..34adda9788d 100644 --- a/doc/api/zlib.md +++ b/doc/api/zlib.md @@ -4,6 +4,8 @@ > Stability: 2 - Stable +<!-- source_link=lib/zlib.js --> + The `zlib` module provides compression functionality implemented using Gzip, Deflate/Inflate, and Brotli. |