Title: About this documentation | Node.js 26.13.1 Documentation
Open Graph Title: About this documentation | Node.js 26.13.1 Documentation
Description: Node.js® is a free, open-source, cross-platform JavaScript runtime environment that lets developers create servers, web apps, command line tools and scripts.
Open Graph Description: Node.js® is a free, open-source, cross-platform JavaScript runtime environment that lets developers create servers, web apps, command line tools and scripts.
Domain: beta.docs.nodejs.org
IPv4 address: 64.239.109.193
| og:type | website |
| theme-color | #0d121c |
| og:image | https://nodejs.org/en/next-data/og/announcement/Node.js — Run JavaScript Everywhere |
Links:
| https://beta.docs.nodejs.org/ | |
| Learn | https://nodejs.org/en/learn |
| About | https://nodejs.org/en/about |
| Download | https://nodejs.org/en/download |
| Docs | https://nodejs.org/docs/latest/api/ |
| Blog | https://nodejs.org/en/blog/ |
| Contribute | https://github.com/nodejs/node/blob/main/CONTRIBUTING.md |
| https://github.com/nodejs/node | |
| About this documentation | https://beta.docs.nodejs.org/index.html |
| Usage and example | https://beta.docs.nodejs.org/synopsis.html |
| Assert | https://beta.docs.nodejs.org/assert.html |
| Async hooks | https://beta.docs.nodejs.org/async_hooks.html |
| Asynchronous context tracking | https://beta.docs.nodejs.org/async_context.html |
| Benchmark runner | https://beta.docs.nodejs.org/bench.html |
| Buffer | https://beta.docs.nodejs.org/buffer.html |
| C++ addons | https://beta.docs.nodejs.org/addons.html |
| C++ embedder API | https://beta.docs.nodejs.org/embedding.html |
| Child process | https://beta.docs.nodejs.org/child_process.html |
| Cluster | https://beta.docs.nodejs.org/cluster.html |
| Command-line API | https://beta.docs.nodejs.org/cli.html |
| Console | https://beta.docs.nodejs.org/console.html |
| Crypto | https://beta.docs.nodejs.org/crypto.html |
| Debugger | https://beta.docs.nodejs.org/debugger.html |
| Deprecated APIs | https://beta.docs.nodejs.org/deprecations.html |
| Diagnostic report | https://beta.docs.nodejs.org/report.html |
| Diagnostics Channel | https://beta.docs.nodejs.org/diagnostics_channel.html |
| DNS | https://beta.docs.nodejs.org/dns.html |
| Domain | https://beta.docs.nodejs.org/domain.html |
| DTLS | https://beta.docs.nodejs.org/dtls.html |
| Environment Variables | https://beta.docs.nodejs.org/environment_variables.html |
| Errors | https://beta.docs.nodejs.org/errors.html |
| Events | https://beta.docs.nodejs.org/events.html |
| FFI | https://beta.docs.nodejs.org/ffi.html |
| File system | https://beta.docs.nodejs.org/fs.html |
| Global objects | https://beta.docs.nodejs.org/globals.html |
| HTTP | https://beta.docs.nodejs.org/http.html |
| HTTP/2 | https://beta.docs.nodejs.org/http2.html |
| HTTPS | https://beta.docs.nodejs.org/https.html |
| Inspector | https://beta.docs.nodejs.org/inspector.html |
| Internationalization support | https://beta.docs.nodejs.org/intl.html |
| Iterable Streams | https://beta.docs.nodejs.org/stream_iter.html |
| Modules: node:module API | https://beta.docs.nodejs.org/module.html |
| Modules: CommonJS modules | https://beta.docs.nodejs.org/modules.html |
| Modules: ECMAScript modules | https://beta.docs.nodejs.org/esm.html |
| Modules: Packages | https://beta.docs.nodejs.org/packages.html |
| Modules: TypeScript | https://beta.docs.nodejs.org/typescript.html |
| Net | https://beta.docs.nodejs.org/net.html |
| Node-API | https://beta.docs.nodejs.org/n-api.html |
| OS | https://beta.docs.nodejs.org/os.html |
| Path | https://beta.docs.nodejs.org/path.html |
| Performance measurement APIs | https://beta.docs.nodejs.org/perf_hooks.html |
| Permissions | https://beta.docs.nodejs.org/permissions.html |
| Process | https://beta.docs.nodejs.org/process.html |
| Punycode | https://beta.docs.nodejs.org/punycode.html |
| Query string | https://beta.docs.nodejs.org/querystring.html |
| Readline | https://beta.docs.nodejs.org/readline.html |
| REPL | https://beta.docs.nodejs.org/repl.html |
| Single executable applications | https://beta.docs.nodejs.org/single-executable-applications.html |
| SQLite | https://beta.docs.nodejs.org/sqlite.html |
| Stream | https://beta.docs.nodejs.org/stream.html |
| String decoder | https://beta.docs.nodejs.org/string_decoder.html |
| Test runner | https://beta.docs.nodejs.org/test.html |
| Timers | https://beta.docs.nodejs.org/timers.html |
| TLS (SSL) | https://beta.docs.nodejs.org/tls.html |
| Trace events | https://beta.docs.nodejs.org/tracing.html |
| TTY | https://beta.docs.nodejs.org/tty.html |
| UDP/datagram sockets | https://beta.docs.nodejs.org/dgram.html |
| URL | https://beta.docs.nodejs.org/url.html |
| Util | https://beta.docs.nodejs.org/util.html |
| V8 | https://beta.docs.nodejs.org/v8.html |
| Virtual File System | https://beta.docs.nodejs.org/vfs.html |
| VM (executing JavaScript) | https://beta.docs.nodejs.org/vm.html |
| Web Crypto API | https://beta.docs.nodejs.org/webcrypto.html |
| Web Streams API | https://beta.docs.nodejs.org/webstreams.html |
| WebAssembly System Interface (WASI) | https://beta.docs.nodejs.org/wasi.html |
| Worker threads | https://beta.docs.nodejs.org/worker_threads.html |
| Zlib | https://beta.docs.nodejs.org/zlib.html |
| Contributing | https://beta.docs.nodejs.org#contributing |
| Stability index | https://beta.docs.nodejs.org#stability-index |
| Stability overview | https://beta.docs.nodejs.org#stability-overview |
| JSON output | https://beta.docs.nodejs.org#json-output |
| System calls and man pages | https://beta.docs.nodejs.org#system-calls-and-man-pages |
| About this documentation | https://beta.docs.nodejs.org#about-this-documentation |
| V8 JavaScript engine | https://v8.dev/ |
| Contributing | https://beta.docs.nodejs.org#contributing |
| the issue tracker | https://github.com/nodejs/node/issues/new |
| the contributing guide | https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md |
| Stability index | https://beta.docs.nodejs.org#stability-index |
| semantic versioning | https://semver.org/ |
| warning | https://beta.docs.nodejs.org/process.html#event-warning |
| Stability overview | https://beta.docs.nodejs.org#stability-overview |
| Usage and example | https://beta.docs.nodejs.org/synopsis.html |
| AssertStableThe node:assert module provides a set of assertion functions for verifying invariants. | https://beta.docs.nodejs.org/assert.html |
| Async hooksExperimentalWe strongly discourage the use of the async_hooks API. Other APIs that can cover most of its use cases include: | https://beta.docs.nodejs.org/async_hooks.html |
| Asynchronous context trackingStable | https://beta.docs.nodejs.org/async_context.html |
| Benchmark runnerExperimentalThe 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: | https://beta.docs.nodejs.org/bench.html |
| BufferStableBuffer objects are used to represent a fixed-length sequence of bytes. Many Node.js APIs support Buffers. | https://beta.docs.nodejs.org/buffer.html |
| C++ addonsAddons 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. | https://beta.docs.nodejs.org/addons.html |
| C++ embedder APINode.js provides a number of C++ APIs that can be used to execute JavaScript in a Node.js environment from other C++ software. | https://beta.docs.nodejs.org/embedding.html |
| Child processStableThe 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: | https://beta.docs.nodejs.org/child_process.html |
| ClusterStableClusters 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. | https://beta.docs.nodejs.org/cluster.html |
| Command-line APINode.js comes with a variety of CLI options. These options expose built-in debugging, multiple ways to execute scripts, and other helpful runtime options. | https://beta.docs.nodejs.org/cli.html |
| ConsoleStableThe node:console module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers. | https://beta.docs.nodejs.org/console.html |
| CryptoStableThe 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. | https://beta.docs.nodejs.org/crypto.html |
| DebuggerStableNode.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. | https://beta.docs.nodejs.org/debugger.html |
| Deprecated APIsNode.js APIs might be deprecated for any of the following reasons: | https://beta.docs.nodejs.org/deprecations.html |
| Diagnostic reportStableDelivers a JSON-formatted diagnostic summary, written to a file. | https://beta.docs.nodejs.org/report.html |
| Diagnostics ChannelStableThe node:diagnostics_channel module provides an API to create named channels to report arbitrary message data for diagnostics purposes. | https://beta.docs.nodejs.org/diagnostics_channel.html |
| DNSStableThe node:dns module enables name resolution. For example, use it to look up IP addresses of host names. | https://beta.docs.nodejs.org/dns.html |
| DomainDeprecatedThis 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. | https://beta.docs.nodejs.org/domain.html |
| DTLSExperimentalThe 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. | https://beta.docs.nodejs.org/dtls.html |
| Environment VariablesEnvironment variables are variables associated to the environment the Node.js process runs in. | https://beta.docs.nodejs.org/environment_variables.html |
| ErrorsApplications running in Node.js will generally experience the following categories of errors: | https://beta.docs.nodejs.org/errors.html |
| EventsStableMuch 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. | https://beta.docs.nodejs.org/events.html |
| FFIExperimentalThe node:ffi module provides an experimental foreign function interface for loading dynamic libraries and calling native symbols from JavaScript. | https://beta.docs.nodejs.org/ffi.html |
| File systemStableThe node:fs module enables interacting with the file system in a way modeled on standard POSIX functions. | https://beta.docs.nodejs.org/fs.html |
| Global objectsStableThese objects are available in all modules. | https://beta.docs.nodejs.org/globals.html |
| HTTPStableThis module, containing both a client and server, can be imported via require('node:http') (CommonJS) or import * as http from 'node:http' (ES module). | https://beta.docs.nodejs.org/http.html |
| HTTP/2StableThe node:http2 module provides an implementation of the HTTP/2 protocol. It can be accessed using: | https://beta.docs.nodejs.org/http2.html |
| HTTPSStableHTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a separate module. | https://beta.docs.nodejs.org/https.html |
| InspectorStableThe node:inspector module provides an API for interacting with the V8 inspector. | https://beta.docs.nodejs.org/inspector.html |
| Internationalization supportNode.js has many features that make it easier to write internationalized programs. Some of them are: | https://beta.docs.nodejs.org/intl.html |
| Iterable StreamsExperimentalThe node:stream/iter module provides a streaming API built on iterables rather than the event-driven Readable/Writable/Transform class hierarchy, or the Web Streams ReadableStream/WritableStream/TransformStream interfaces. | https://beta.docs.nodejs.org/stream_iter.html |
| Modules: `node:module` APIStableThe node:module module provides utilities for interacting with the Node.js module system. | https://beta.docs.nodejs.org/module.html |
| Modules: CommonJS modulesStableCommonJS modules are the original way to package JavaScript code for Node.js. Node.js also supports the ECMAScript modules standard used by browsers and other JavaScript runtimes. | https://beta.docs.nodejs.org/modules.html |
| Modules: ECMAScript modulesStable | https://beta.docs.nodejs.org/esm.html |
| Modules: Packages | https://beta.docs.nodejs.org/packages.html |
| Modules: TypeScriptStable | https://beta.docs.nodejs.org/typescript.html |
| NetStableThe node:net module provides an asynchronous network API for creating stream-based TCP or IPC servers (net.createServer()) and clients (net.createConnection()). | https://beta.docs.nodejs.org/net.html |
| Node-APIStableNode-API (formerly N-API) is an API for building native Addons. It is independent from the underlying JavaScript runtime (for example, V8) and is maintained as part of Node.js itself. This API will be Application Binary Interface (ABI) stable across versions of Node.js. It is intended to insulate addons from changes in the underlying JavaScript engine and allow modules compiled for one major version to run on later major versions of Node.js without recompilation. The ABI Stability guide provides a more in-depth explanation. | https://beta.docs.nodejs.org/n-api.html |
| OSStableThe node:os module provides operating system-related utility methods and properties. It can be accessed using: | https://beta.docs.nodejs.org/os.html |
| PathStableThe node:path module provides utilities for working with file and directory paths. It can be accessed using: | https://beta.docs.nodejs.org/path.html |
| Performance measurement APIsStableThis module provides an implementation of a subset of the W3C Web Performance APIs as well as additional APIs for Node.js-specific performance measurements. | https://beta.docs.nodejs.org/perf_hooks.html |
| PermissionsPermissions 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. | https://beta.docs.nodejs.org/permissions.html |
| ProcessThe process object provides information about, and control over, the current Node.js process. | https://beta.docs.nodejs.org/process.html |
| PunycodeDeprecatedThe 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 userland-provided Punycode.js module instead. For punycode-based URL encoding, see url.domainToASCII or, more generally, the WHATWG URL API. | https://beta.docs.nodejs.org/punycode.html |
| Query stringStableThe node:querystring module provides utilities for parsing and formatting URL query strings. It can be accessed using: | https://beta.docs.nodejs.org/querystring.html |
| ReadlineStableThe node:readline module provides an interface for reading data from a Readable stream (such as process.stdin) one line at a time. | https://beta.docs.nodejs.org/readline.html |
| REPLStableThe node: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: | https://beta.docs.nodejs.org/repl.html |
| Single executable applicationsExperimentalThis feature allows the distribution of a Node.js application conveniently to a system that does not have Node.js installed. | https://beta.docs.nodejs.org/single-executable-applications.html |
| SQLiteExperimentalThe node:sqlite module facilitates working with SQLite databases. To access it: | https://beta.docs.nodejs.org/sqlite.html |
| StreamStableA stream is an abstract interface for working with streaming data in Node.js. The node:stream module provides an API for implementing the stream interface. | https://beta.docs.nodejs.org/stream.html |
| String decoderStableThe node: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: | https://beta.docs.nodejs.org/string_decoder.html |
| Test runnerStableThe node:test module facilitates the creation of JavaScript tests. To access it: | https://beta.docs.nodejs.org/test.html |
| TimersStableThe 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('node:timers') to use the API. | https://beta.docs.nodejs.org/timers.html |
| TLS (SSL)StableThe node: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: | https://beta.docs.nodejs.org/tls.html |
| Trace eventsExperimentalThe node:trace_events module provides a mechanism to centralize tracing information generated by V8, Node.js core, and userspace code. | https://beta.docs.nodejs.org/tracing.html |
| TTYStableThe node: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: | https://beta.docs.nodejs.org/tty.html |
| UDP/datagram socketsStableThe node:dgram module provides an implementation of UDP datagram sockets. | https://beta.docs.nodejs.org/dgram.html |
| URLStableThe node:url module provides utilities for URL resolution and parsing. It can be accessed using: | https://beta.docs.nodejs.org/url.html |
| UtilStableThe node: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: | https://beta.docs.nodejs.org/util.html |
| V8The node:v8 module exposes APIs that are specific to the version of V8 built into the Node.js binary. It can be accessed using: | https://beta.docs.nodejs.org/v8.html |
| Virtual File SystemExperimentalThe node:vfs module provides a virtual file system with a node:fs-like API. It is useful for tests, fixtures, embedded assets, and other scenarios where you need a self-contained file system without touching the actual file-system. | https://beta.docs.nodejs.org/vfs.html |
| VM (executing JavaScript)StableThe node:vm module enables compiling and running code within V8 Virtual Machine contexts. | https://beta.docs.nodejs.org/vm.html |
| Web Crypto APIStableNode.js provides an implementation of the Web Crypto API standard. | https://beta.docs.nodejs.org/webcrypto.html |
| Web Streams APIStableAn implementation of the WHATWG Streams Standard. | https://beta.docs.nodejs.org/webstreams.html |
| WebAssembly System Interface (WASI)ExperimentalThe node:wasi module does not currently provide the comprehensive file system security properties provided by some WASI runtimes. Full support for secure file system sandboxing may or may not be implemented in future. In the mean time, do not rely on it to run untrusted code. | https://beta.docs.nodejs.org/wasi.html |
| Worker threadsStableThe node:worker_threads module enables the use of threads that execute JavaScript in parallel. To access it: | https://beta.docs.nodejs.org/worker_threads.html |
| ZlibStableThe node:zlib module provides compression functionality implemented using Gzip, Deflate/Inflate, Brotli, and Zstd. | https://beta.docs.nodejs.org/zlib.html |
| JSON output | https://beta.docs.nodejs.org#json-output |
| System calls and man pages | https://beta.docs.nodejs.org#system-calls-and-man-pages |
| JSON | https://beta.docs.nodejs.org/index.json |
| MD | https://beta.docs.nodejs.org/index.md |
| Edit this page | https://github.com/nodejs/node/edit/HEAD/doc/api/index.md |
| Contributing | https://beta.docs.nodejs.org#contributing |
| Stability indexL | https://beta.docs.nodejs.org#stability-index |
| Stability overview | https://beta.docs.nodejs.org#stability-overview |
| JSON output | https://beta.docs.nodejs.org#json-output |
| System calls and man pages | https://beta.docs.nodejs.org#system-calls-and-man-pages |
| Server | Vercel |
| Content-Type | text/html; charset=utf-8 |
| Cache-Control | public, max-age=0, must-revalidate |
| Last-Modified | Sat, 21 Nov 2026 08:51:33 GMT |
Viewport: width=device-width, initial-scale=1.0