Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/api/async_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@

<!-- source_link=lib/async_hooks.js -->

<!-- YAML
llm_description: >
Tracks asynchronous execution context. Enables storing and propagating state
across async operations like callbacks and promises. Useful for request
tracking, logging, or context management. Provides AsyncLocalStorage for
scoped storage and AsyncResource for custom async context binding.
-->

## Introduction

These classes are used to associate state and propagate it throughout
Expand Down
7 changes: 7 additions & 0 deletions doc/api/async_hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

<!--introduced_in=v8.1.0-->

<!-- YAML
llm_description: >
Low-level API to monitor asynchronous operations (timeouts, promises,
callbacks). Primarily for advanced diagnostics or custom profiling tools.
Avoid on production, use AsyncLocalStorage for most context-tracking needs.
-->

> Stability: 1 - Experimental. Please migrate away from this API, if you can.
> We do not recommend using the [`createHook`][], [`AsyncHook`][], and
> [`executionAsyncResource`][] APIs as they have usability issues, safety risks,
Expand Down
7 changes: 7 additions & 0 deletions doc/api/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

<!--introduced_in=v0.10.0-->

<!-- YAML
llm_description: >
Enables multi-process scaling by forking identical Node.js instances
(workers) to handle loads across CPU cores. Ideal for HTTP servers needing
parallelism. For lightweight concurrency, prefer worker_threads.
-->

> Stability: 2 - Stable

<!-- source_link=lib/cluster.js -->
Expand Down
6 changes: 6 additions & 0 deletions doc/api/debugger.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

<!--introduced_in=v0.9.12-->

<!-- YAML
llm_description: >
Provides a CLI interface for debugging Node.js applications, including
basic stepping and inspection.
-->

> Stability: 2 - Stable

<!-- type=misc -->
Expand Down
5 changes: 5 additions & 0 deletions doc/api/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

<!--introduced_in=v7.7.0-->

<!-- YAML
llm_description: >
Lists APIs that are deprecated and subject to removal in future releases.
-->

<!-- type=misc -->

Node.js APIs might be deprecated for any of the following reasons:
Expand Down
7 changes: 7 additions & 0 deletions doc/api/diagnostics_channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ changes:

<!--introduced_in=v15.1.0-->

<!-- YAML
llm_description: >
Publish/subscribe API for custom diagnostic events (e.g., database query
metrics, HTTP request lifecycle). Integrates with APM tools or logging
systems to monitor internal operations.
-->

> Stability: 2 - Stable

<!-- source_link=lib/diagnostics_channel.js -->
Expand Down
5 changes: 5 additions & 0 deletions doc/api/domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ changes:

<!--introduced_in=v0.10.0-->

<!-- YAML
llm_description: >
Deprecated (avoid). Legacy API for error handling across async operations.
-->

> Stability: 0 - Deprecated

<!-- source_link=lib/domain.js -->
Expand Down
5 changes: 5 additions & 0 deletions doc/api/errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

<!--introduced_in=v4.0.0-->

<!-- YAML
llm_description: >
Describes the error types in Node.js and how they are handled during execution.
-->

<!--type=misc-->

Applications running in Node.js will generally experience the following
Expand Down
6 changes: 6 additions & 0 deletions doc/api/esm.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

<!--introduced_in=v8.5.0-->

<!-- YAML
llm_description: >
Provides support for ECMAScript modules in Node.js, enabling standards-based
module syntax (import/export) and interoperability with CommonJS.
-->

<!-- type=misc -->

<!-- YAML
Expand Down
5 changes: 5 additions & 0 deletions doc/api/globals.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

<!--introduced_in=v0.10.0-->

<!-- YAML
llm_description: >
Lists built-in global objects and functions available in the Node.js runtime.
-->

<!-- type=misc -->

> Stability: 2 - Stable
Expand Down
6 changes: 6 additions & 0 deletions doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

<!--introduced_in=v0.10.0-->

<!-- YAML
llm_description: >
Provides functionality for creating HTTP servers and clients, enabling the
handling of HTTP requests and responses.
-->

> Stability: 2 - Stable

<!-- source_link=lib/http.js -->
Expand Down
2 changes: 2 additions & 0 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ changes:

<!--introduced_in=v8.4.0-->

<!-- llm_description: Enables HTTP/2 protocol support. -->

> Stability: 2 - Stable

<!-- source_link=lib/http2.js -->
Expand Down
2 changes: 2 additions & 0 deletions doc/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

<!--introduced_in=v0.10.0-->

<!-- llm_description: Entry point for the Node.js documentation index. -->

* [About this documentation](documentation.md)
* [Usage and example](synopsis.md)

Expand Down
6 changes: 6 additions & 0 deletions doc/api/inspector.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

<!--introduced_in=v8.0.0-->

<!-- YAML
llm_description: >
Enables programmatic interaction with the V8 Inspector for debugging and
profiling.
-->

> Stability: 2 - Stable

<!-- source_link=lib/inspector.js -->
Expand Down
7 changes: 7 additions & 0 deletions doc/api/module.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

<!--introduced_in=v12.20.0-->

<!-- YAML
llm_description: >
Provides utilities for interacting with Node.js modules, including support
for module creation, resolution, customization hooks, and compile caching.
Enables advanced module loading behavior.
-->

<!-- YAML
added: v0.3.7
-->
Expand Down
6 changes: 6 additions & 0 deletions doc/api/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

<!--introduced_in=v0.10.0-->

<!-- YAML
llm_description: >
Node supports both CommonJS (require()) and ES Modules (import/export). Use
ESM, which enables browser compatibility and top-level await.
-->

> Stability: 2 - Stable

<!--name=module-->
Expand Down
7 changes: 7 additions & 0 deletions doc/api/os.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

<!--introduced_in=v0.10.0-->

<!-- YAML
llm_description: >
Provides cross-platform utilities for accessing operating system information,
including CPU architecture, memory usage, network interfaces, user details,
and system paths.
-->

> Stability: 2 - Stable

<!-- source_link=lib/os.js -->
Expand Down
7 changes: 7 additions & 0 deletions doc/api/packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@

<!-- type=misc -->

<!-- YAML
llm_description: >
Defines how Node.js resolves and loads modules via fields like type,
exports, and imports. Controls module format, entry points, and package
encapsulation.
-->

<!-- YAML
changes:
- version:
Expand Down
6 changes: 6 additions & 0 deletions doc/api/path.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

<!--introduced_in=v0.10.0-->

<!-- YAML
llm_description: >
Provides utilities for working with file and directory paths across
different operating systems.
-->

> Stability: 2 - Stable

<!-- source_link=lib/path.js -->
Expand Down
6 changes: 6 additions & 0 deletions doc/api/querystring.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

<!--introduced_in=v0.1.25-->

<!-- YAML
llm_description: >
Parses and formats URL query strings, providing fast utilities for handling
key-value pairs.
-->

> Stability: 2 - Stable

<!--name=querystring-->
Expand Down
2 changes: 2 additions & 0 deletions doc/api/quic.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

<!-- introduced_in=v23.8.0-->

<!-- llm_description: Provides an implementation of the QUIC protocol. -->

<!-- YAML
added: v23.8.0
-->
Expand Down
5 changes: 5 additions & 0 deletions doc/api/repl.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

<!--introduced_in=v0.10.0-->

<!-- YAML
llm_description: >
Provides an interactive Read-Eval-Print-Loop (REPL) implementation.
-->

> Stability: 2 - Stable

<!-- source_link=lib/repl.js -->
Expand Down
7 changes: 7 additions & 0 deletions doc/api/sqlite.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

<!--introduced_in=v22.5.0-->

<!-- YAML
llm_description: >
Provides synchronous APIs for working with SQLite databases, including
querying, transactions, backups, and change tracking. Enables in-process,
file-based SQL storage.
-->

<!-- YAML
added: v22.5.0
-->
Expand Down
6 changes: 6 additions & 0 deletions doc/api/string_decoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

<!--introduced_in=v0.10.0-->

<!-- YAML
llm_description: >
Provides an API for decoding Buffer objects into strings while preserving
multi-byte UTF-8 and UTF-16 characters.
-->

> Stability: 2 - Stable

<!-- source_link=lib/string_decoder.js -->
Expand Down
6 changes: 6 additions & 0 deletions doc/api/synopsis.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Usage and example

<!-- YAML
llm_description: >
Overview of basic Node.js usage via CLI. Illustrates how to run scripts and
provides a simple web server example.
-->

## Usage

<!--introduced_in=v0.10.0-->
Expand Down
7 changes: 7 additions & 0 deletions doc/api/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

<!--introduced_in=v18.0.0-->

<!-- YAML
llm_description: >
Built-in framework for writing and running JavaScript tests. It includes a
command-line runner and offers comprehensive features such as mocking,
snapshot testing, and code coverage analysis.
-->

<!-- YAML
added:
- v18.0.0
Expand Down
6 changes: 6 additions & 0 deletions doc/api/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

<!--introduced_in=v0.10.0-->

<!-- YAML
llm_description: >
Implements Transport Layer Security (TLS) and Secure Socket Layer (SSL)
protocols using OpenSSL.
-->

> Stability: 2 - Stable

<!-- source_link=lib/tls.js -->
Expand Down
6 changes: 6 additions & 0 deletions doc/api/tty.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

<!--introduced_in=v0.10.0-->

<!-- YAML
llm_description: >
The tty module handles terminal (TTY) interactions, providing classes to
manage readable and writable streams for terminal IO.
-->

> Stability: 2 - Stable

<!-- source_link=lib/tty.js -->
Expand Down
6 changes: 6 additions & 0 deletions doc/api/typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ changes:

<!--introduced_in=v22.6.0-->

<!-- YAML
llm_description: >
Provides lightweight TypeScript support in Node.js via type stripping.
Enables execution of .ts files without type checking or full compiler features.
-->

> Stability: 1.2 - Release candidate

## Enabling
Expand Down
5 changes: 5 additions & 0 deletions doc/api/url.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

<!--introduced_in=v0.10.0-->

<!-- YAML
llm_description: >
Provides utilities for parsing, constructing, and manipulating URLs.
-->

> Stability: 2 - Stable

<!-- source_link=lib/url.js -->
Expand Down
6 changes: 6 additions & 0 deletions doc/api/v8.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

<!--introduced_in=v4.0.0-->

<!-- YAML
llm_description: >
Exposes APIs that are specific to the version of V8 built into the Node.js
binary.
-->

<!-- source_link=lib/v8.js -->

The `node:v8` module exposes APIs that are specific to the version of [V8][]
Expand Down
Loading
Loading