Browse Source

doc: Add stability indicators to documentation

v0.8.7-release
isaacs 13 years ago
parent
commit
2d44dcc8be
  1. 2
      doc/api/assert.markdown
  2. 2
      doc/api/child_process.markdown
  3. 2
      doc/api/cluster.markdown
  4. 2
      doc/api/crypto.markdown
  5. 2
      doc/api/debugger.markdown
  6. 2
      doc/api/dgram.markdown
  7. 2
      doc/api/dns.markdown
  8. 2
      doc/api/events.markdown
  9. 2
      doc/api/fs.markdown
  10. 2
      doc/api/http.markdown
  11. 2
      doc/api/https.markdown
  12. 2
      doc/api/modules.markdown
  13. 2
      doc/api/net.markdown
  14. 2
      doc/api/os.markdown
  15. 2
      doc/api/path.markdown
  16. 2
      doc/api/querystring.markdown
  17. 2
      doc/api/readline.markdown
  18. 2
      doc/api/stdio.markdown
  19. 2
      doc/api/stream.markdown
  20. 2
      doc/api/timers.markdown
  21. 2
      doc/api/tls.markdown
  22. 14
      doc/api/tty.markdown
  23. 2
      doc/api/url.markdown
  24. 2
      doc/api/util.markdown
  25. 2
      doc/api/vm.markdown
  26. 2
      doc/api/zlib.markdown

2
doc/api/assert.markdown

@ -1,5 +1,7 @@
# Assert # Assert
Stability: 5 - Locked
This module is used for writing unit tests for your applications, you can This module is used for writing unit tests for your applications, you can
access it with `require('assert')`. access it with `require('assert')`.

2
doc/api/child_process.markdown

@ -1,5 +1,7 @@
# Child Process # Child Process
Stability: 3 - Stable
Node provides a tri-directional `popen(3)` facility through the Node provides a tri-directional `popen(3)` facility through the
`child_process` module. `child_process` module.

2
doc/api/cluster.markdown

@ -1,5 +1,7 @@
# Cluster # Cluster
Stability: 1 Experimental - Drastic changes in future versions
A single instance of Node runs in a single thread. To take advantage of 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 multi-core systems the user will sometimes want to launch a cluster of Node
processes to handle the load. processes to handle the load.

2
doc/api/crypto.markdown

@ -1,5 +1,7 @@
# Crypto # Crypto
Stability: 3 - Stable
Use `require('crypto')` to access this module. Use `require('crypto')` to access this module.
The crypto module requires OpenSSL to be available on the underlying platform. The crypto module requires OpenSSL to be available on the underlying platform.

2
doc/api/debugger.markdown

@ -1,5 +1,7 @@
# Debugger # Debugger
Stability: 3 - Stable
<!-- type=misc --> <!-- type=misc -->
V8 comes with an extensive debugger which is accessible out-of-process via a V8 comes with an extensive debugger which is accessible out-of-process via a

2
doc/api/dgram.markdown

@ -1,5 +1,7 @@
# UDP / Datagram Sockets # UDP / Datagram Sockets
Stability: 3 - Stable
<!-- name=dgram --> <!-- name=dgram -->
Datagram sockets are available through `require('dgram')`. Datagram sockets are available through `require('dgram')`.

2
doc/api/dns.markdown

@ -1,5 +1,7 @@
# DNS # DNS
Stability: 3 - Stable
Use `require('dns')` to access this module. All methods in the dns module 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 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 pool. C-Ares is much faster than `getaddrinfo` but the system resolver is

2
doc/api/events.markdown

@ -1,5 +1,7 @@
# Events # Events
Stability: 4 - API Frozen
<!--type=module--> <!--type=module-->
Many objects in Node emit events: a `net.Server` emits an event each time Many objects in Node emit events: a `net.Server` emits an event each time

2
doc/api/fs.markdown

@ -1,5 +1,7 @@
# File System # File System
Stability: 3 - Stable
File I/O is provided by simple wrappers around standard POSIX functions. To 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 use this module do `require('fs')`. All the methods have asynchronous and
synchronous forms. synchronous forms.

2
doc/api/http.markdown

@ -1,5 +1,7 @@
# HTTP # HTTP
Stability: 3 - Stable
To use the HTTP server and client one must `require('http')`. To use the HTTP server and client one must `require('http')`.
The HTTP interfaces in Node are designed to support many features The HTTP interfaces in Node are designed to support many features

2
doc/api/https.markdown

@ -1,5 +1,7 @@
# HTTPS # HTTPS
Stability: 3 - Stable
HTTPS is the HTTP protocol over TLS/SSL. In Node this is implemented as a HTTPS is the HTTP protocol over TLS/SSL. In Node this is implemented as a
separate module. separate module.

2
doc/api/modules.markdown

@ -1,5 +1,7 @@
# Modules # Modules
Stability: 5 - Locked
<!--name=module--> <!--name=module-->
Node has a simple module loading system. In Node, files and modules are in Node has a simple module loading system. In Node, files and modules are in

2
doc/api/net.markdown

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

2
doc/api/os.markdown

@ -1,5 +1,7 @@
# os # os
Stability: 4 - API Frozen
Provides a few basic operating-system related utility functions. Provides a few basic operating-system related utility functions.
Use `require('os')` to access this module. Use `require('os')` to access this module.

2
doc/api/path.markdown

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

2
doc/api/querystring.markdown

@ -1,5 +1,7 @@
# Query String # Query String
Stability: 3 - Stable
<!--name=querystring--> <!--name=querystring-->
This module provides utilities for dealing with query strings. This module provides utilities for dealing with query strings.

2
doc/api/readline.markdown

@ -1,5 +1,7 @@
# Readline # Readline
Stability: 3 - Stable
To use this module, do `require('readline')`. Readline allows reading of a To use this module, do `require('readline')`. Readline allows reading of a
stream (such as STDIN) on a line-by-line basis. stream (such as STDIN) on a line-by-line basis.

2
doc/api/stdio.markdown

@ -1,5 +1,7 @@
# console # console
Stability: 4 - API Frozen
* {Object} * {Object}
<!--type=global--> <!--type=global-->

2
doc/api/stream.markdown

@ -1,5 +1,7 @@
# Stream # Stream
Stability: 2 - Unstable
A stream is an abstract interface implemented by various objects in Node. 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 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`. are readable, writable, or both. All streams are instances of `EventEmitter`.

2
doc/api/timers.markdown

@ -1,5 +1,7 @@
# Timers # Timers
Stability: 5 - Locked
All of the timer functions are globals. You do not need to `require()` All of the timer functions are globals. You do not need to `require()`
this module in order to use them. this module in order to use them.

2
doc/api/tls.markdown

@ -1,5 +1,7 @@
# TLS (SSL) # TLS (SSL)
Stability: 3 - Stable
Use `require('tls')` to access this module. Use `require('tls')` to access this module.
The `tls` module uses OpenSSL to provide Transport Layer Security and/or The `tls` module uses OpenSSL to provide Transport Layer Security and/or

14
doc/api/tty.markdown

@ -1,5 +1,7 @@
# TTY # TTY
Stability: 3 - Stable
Use `require('tty')` to access this module. Use `require('tty')` to access this module.
Example: Example:
@ -26,15 +28,3 @@ terminal.
`mode` should be `true` or `false`. This sets the properties of the current `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. 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.

2
doc/api/url.markdown

@ -1,5 +1,7 @@
# URL # URL
Stability: 3 - Stable
This module has utilities for URL resolution and parsing. This module has utilities for URL resolution and parsing.
Call `require('url')` to use it. Call `require('url')` to use it.

2
doc/api/util.markdown

@ -1,5 +1,7 @@
# util # util
Stability: 5 - Locked
These functions are in the module `'util'`. Use `require('util')` to access These functions are in the module `'util'`. Use `require('util')` to access
them. them.

2
doc/api/vm.markdown

@ -1,5 +1,7 @@
# Executing JavaScript # Executing JavaScript
Stability: 3 - Stable
<!--name=vm--> <!--name=vm-->
You can access this module with: You can access this module with:

2
doc/api/zlib.markdown

@ -1,5 +1,7 @@
# Zlib # Zlib
Stability: 3 - Stable
You can access this module with: You can access this module with:
var zlib = require('zlib'); var zlib = require('zlib');

Loading…
Cancel
Save