Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

doc: Add stability indicators to documentation

  • Loading branch information...
isaacs committed Mar 2, 2012
1 parent 2f256af commit 2d44dcc8be9dc8d9b1dde3f68983478aa30de59c
@@ -1,5 +1,7 @@
# Assert

Stability: 5 - Locked

This module is used for writing unit tests for your applications, you can
access it with `require('assert')`.

@@ -1,5 +1,7 @@
# Child Process

Stability: 3 - Stable

Node provides a tri-directional `popen(3)` facility through the
`child_process` module.

@@ -1,5 +1,7 @@
# Cluster

Stability: 1 Experimental - Drastic changes in future versions

A single instance of Node runs in a single thread. To take advantage of
multi-core systems the user will sometimes want to launch a cluster of Node
processes to handle the load.
@@ -1,5 +1,7 @@
# Crypto

Stability: 3 - Stable

Use `require('crypto')` to access this module.

The crypto module requires OpenSSL to be available on the underlying platform.
@@ -1,5 +1,7 @@
# Debugger

Stability: 3 - Stable

<!-- type=misc -->

V8 comes with an extensive debugger which is accessible out-of-process via a
@@ -1,5 +1,7 @@
# UDP / Datagram Sockets

Stability: 3 - Stable

<!-- name=dgram -->

Datagram sockets are available through `require('dgram')`.
@@ -1,5 +1,7 @@
# DNS

Stability: 3 - Stable

Use `require('dns')` to access this module. All methods in the dns module
use C-Ares except for `dns.lookup` which uses `getaddrinfo(3)` in a thread
pool. C-Ares is much faster than `getaddrinfo` but the system resolver is
@@ -1,5 +1,7 @@
# Events

Stability: 4 - API Frozen

<!--type=module-->

Many objects in Node emit events: a `net.Server` emits an event each time
@@ -1,5 +1,7 @@
# File System

Stability: 3 - Stable

File I/O is provided by simple wrappers around standard POSIX functions. To
use this module do `require('fs')`. All the methods have asynchronous and
synchronous forms.
@@ -1,5 +1,7 @@
# HTTP

Stability: 3 - Stable

To use the HTTP server and client one must `require('http')`.

The HTTP interfaces in Node are designed to support many features
@@ -1,5 +1,7 @@
# HTTPS

Stability: 3 - Stable

HTTPS is the HTTP protocol over TLS/SSL. In Node this is implemented as a
separate module.

@@ -1,5 +1,7 @@
# Modules

Stability: 5 - Locked

<!--name=module-->

Node has a simple module loading system. In Node, files and modules are in
@@ -1,5 +1,7 @@
# net

Stability: 3 - Stable

The `net` module provides you with an asynchronous network wrapper. It contains
methods for creating both servers and clients (called streams). You can include
this module with `require('net');`
@@ -1,5 +1,7 @@
# os

Stability: 4 - API Frozen

Provides a few basic operating-system related utility functions.

Use `require('os')` to access this module.
@@ -1,5 +1,7 @@
# Path

Stability: 3 - Stable

This module contains utilities for handling and transforming file
paths. Almost all these methods perform only string transformations.
The file system is not consulted to check whether paths are valid.
@@ -1,5 +1,7 @@
# Query String

Stability: 3 - Stable

<!--name=querystring-->

This module provides utilities for dealing with query strings.
@@ -1,5 +1,7 @@
# Readline

Stability: 3 - Stable

To use this module, do `require('readline')`. Readline allows reading of a
stream (such as STDIN) on a line-by-line basis.

@@ -1,5 +1,7 @@
# console

Stability: 4 - API Frozen

* {Object}

<!--type=global-->
@@ -1,5 +1,7 @@
# Stream

Stability: 2 - Unstable

A stream is an abstract interface implemented by various objects in Node.
For example a request to an HTTP server is a stream, as is stdout. Streams
are readable, writable, or both. All streams are instances of `EventEmitter`.
@@ -1,5 +1,7 @@
# Timers

Stability: 5 - Locked

All of the timer functions are globals. You do not need to `require()`
this module in order to use them.

@@ -1,5 +1,7 @@
# TLS (SSL)

Stability: 3 - Stable

Use `require('tls')` to access this module.

The `tls` module uses OpenSSL to provide Transport Layer Security and/or
@@ -1,5 +1,7 @@
# TTY

Stability: 3 - Stable

Use `require('tty')` to access this module.

Example:
@@ -26,15 +28,3 @@ terminal.

`mode` should be `true` or `false`. This sets the properties of the current
process's stdin fd to act either as a raw device or default.


## tty.setWindowSize(fd, row, col)

This function was removed in v0.6.0.

## tty.getWindowSize(fd)

This function was removed in v0.6.0. Use `process.stdout.getWindowSize()`
instead.


@@ -1,5 +1,7 @@
# URL

Stability: 3 - Stable

This module has utilities for URL resolution and parsing.
Call `require('url')` to use it.

@@ -1,5 +1,7 @@
# util

Stability: 5 - Locked

These functions are in the module `'util'`. Use `require('util')` to access
them.

@@ -1,5 +1,7 @@
# Executing JavaScript

Stability: 3 - Stable

<!--name=vm-->

You can access this module with:
@@ -1,5 +1,7 @@
# Zlib

Stability: 3 - Stable

You can access this module with:

var zlib = require('zlib');

0 comments on commit 2d44dcc

Please sign in to comment.
You can’t perform that action at this time.