About documentation

There are several types of documentation available on this website:

  • API reference documentation
  • ES6 features
  • Guides
  • Dependencies

API reference documentation

The API reference documentation provides detailed information about a function or object in Node.js. This documentation indicates what arguments a method accepts, the return value of that method, and what errors may be related to that method. It also indicates which methods are available for different versions of Node.js.

This documentation describes the built-in modules provided by Node.js. It does not document modules provided by the community.

ES6 features

The ES6 section describes the three ES6 feature groups, and details which features are enabled by default in Node.js, alongside explanatory links. It also shows how to find which version of V8 shipped with a particular Node.js release.

Guides

The Guides section has long-form, in-depth articles about Node.js technical features and capabilities.

Dependencies

Node.js depends on additional components beyond the Node.js code itself. These dependencies provide both native and JavaScript code and are built together with the code under the src and lib directories to create the Node.js binaries.

Scroll to top