nodejs.org llms.txt

llms.txt 15 KB, 77 lines

# Node.js Documentation

> Node.js is an open-source, cross-platform JavaScript runtime environment that executes JavaScript code outside a web browser. Node.js uses an event-driven, non-blocking I/O model that makes it lightweight and efficient for building scalable network applications.

Below are the sections of the API documentation. Look out especially towards the links that point towards guidance/introduction to the structure of this documentation.

## API Documentations
- [C++ addons](https://nodejs.org/docs/latest/api/addons.md): _Addons_ are dynamically-linked shared objects that can be loaded via the `require()` function as ordinary Node.js modules. Addons provide a foreign function interface between JavaScript and native code.
- [Assert](https://nodejs.org/docs/latest/api/assert.md): The `node:assert` module provides a set of assertion functions for verifying invariants.
- [Asynchronous context tracking](https://nodejs.org/docs/latest/api/async_context.md): 
- [Async hooks](https://nodejs.org/docs/latest/api/async_hooks.md): We strongly discourage the use of the `async_hooks` API. Other APIs that can cover most of its use cases include:
- [Benchmark runner](https://nodejs.org/docs/latest/api/bench.md): The `node:bench` module supports defining and running JavaScript benchmarks in the current process, and running one benchmark file in a fresh child process. The module is only available when Node.js is started with the `--experimental-bench` flag and can only be imported with the `node:` scheme:
- [Buffer](https://nodejs.org/docs/latest/api/buffer.md): `Buffer` objects are used to represent a fixed-length sequence of bytes. Many Node.js APIs support `Buffer`s.
- [Child process](https://nodejs.org/docs/latest/api/child_process.md): The `node:child_process` module provides the ability to spawn subprocesses in a manner that is similar, but not identical, to `popen(3)`. This capability is primarily provided by the `child_process.spawn()` function:
- [Command-line API](https://nodejs.org/docs/latest/api/cli.md): Node.js comes with a variety of CLI options. These options expose built-in debugging, multiple ways to execute scripts, and other helpful runtime options.
- [Cluster](https://nodejs.org/docs/latest/api/cluster.md): Clusters of Node.js processes can be used to run multiple instances of Node.js that can distribute workloads among their application threads. When process isolation is not needed, use the `worker_threads` module instead, which allows running multiple application threads within a single Node.js instance.
- [Console](https://nodejs.org/docs/latest/api/console.md): The `node:console` module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers.
- [Crypto](https://nodejs.org/docs/latest/api/crypto.md): The `node:crypto` module provides cryptographic functionality that includes a set of wrappers for OpenSSL's hash, message authentication code (MAC), cipher, decipher, sign, verify, and key encapsulation mechanism (KEM) functions.
- [Debugger](https://nodejs.org/docs/latest/api/debugger.md): Node.js includes a command-line debugging utility. The Node.js debugger client is not a full-featured debugger, but simple stepping and inspection are possible.
- [Deprecated APIs](https://nodejs.org/docs/latest/api/deprecations.md): Node.js APIs might be deprecated for any of the following reasons:
- [UDP/datagram sockets](https://nodejs.org/docs/latest/api/dgram.md): The `node:dgram` module provides an implementation of UDP datagram sockets.
- [Diagnostics Channel](https://nodejs.org/docs/latest/api/diagnostics_channel.md): The `node:diagnostics_channel` module provides an API to create named channels to report arbitrary message data for diagnostics purposes.
- [DNS](https://nodejs.org/docs/latest/api/dns.md): The `node:dns` module enables name resolution. For example, use it to look up IP addresses of host names.
- [About this documentation](https://nodejs.org/docs/latest/api/documentation.md): Welcome to the official API reference documentation for Node.js!
- [Domain](https://nodejs.org/docs/latest/api/domain.md): **This module is pending deprecation.** Once a replacement API has been finalized, this module will be fully deprecated. Most developers should **not** have cause to use this module. Users who absolutely must have the functionality that domains provide may rely on it for the time being but should expect to have to migrate to a different solution in the future.
- [DTLS](https://nodejs.org/docs/latest/api/dtls.md): The `node:dtls` module provides an implementation of the Datagram Transport Layer Security (DTLS) protocol over UDP. DTLS provides TLS-equivalent security guarantees for datagram-based communication, including confidentiality, integrity, and authentication.
- [C++ embedder API](https://nodejs.org/docs/latest/api/embedding.md): Node.js provides a number of C++ APIs that can be used to execute JavaScript in a Node.js environment from other C++ software.
- [Performance measurement APIs](https://nodejs.org/docs/latest/api/perf_hooks.md): 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.
- [Permissions](https://nodejs.org/docs/latest/api/permissions.md): Permissions can be used to control what system resources the Node.js process has access to or what actions the process can take with those resources.

First 29 of 77 lines.