- Assertion Testing
- Async Hooks
- C++ Addons
- C/C++ Addons with N-API
- Child Processes
- Command Line Options
- Deprecated APIs
- ECMAScript Modules
- File System
- Performance Hooks
- Query Strings
- String Decoder
- Trace Events
- Worker Threads
Table of Contents
About this Documentation#
Welcome to the official API reference documentation for Node.js!
Throughout the documentation are indications of a section's stability. Some APIs are so proven and so relied upon that they are unlikely to ever change at all. Others are brand new and experimental, or known to be hazardous.
The stability indices are as follows:
Use caution when making use of Experimental features, particularly within modules. End users may not be aware that experimental features are being used. Bugs or behavior changes may surprise end users when Experimental API modifications occur. To avoid surprises, use of an Experimental feature may need a command-line flag. Experimental features may also emit a warning.
.html document has a corresponding
.json document. This is for IDEs
and other utilities that consume the documentation.
System calls and man pages#
Node.js functions which wrap a system call will document that. The docs link to the corresponding man pages which describe how the system call works.
Most Unix system calls have Windows analogues. Still, behavior differences may be unavoidable.