1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: update stability index

Browse Source 
This simplifies the stability index to 4 levels:

0 - deprecated
1 - experimental / feature-flagged
2 - stable
3 - locked

Domains has been downgraded to deprecated, assert has been
downgraded to stable. Timers and Module remain locked. All
other APIs are now stable.

PR-URL: https://github.com/iojs/io.js/pull/943
Fixes: https://github.com/iojs/io.js/issues/930
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Vladimir Kurchatkin <vladimir.kurchatkin@gmail.com>
This commit is contained in:
Chris Dickinson 2015-02-24 16:15:26 -08:00
parent fb2439a699
commit cf0306cd71
35 changed files with 42 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/api/assert.markdown
View File

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

2
doc/api/buffer.markdown
View File

@ -1,6 +1,6 @@
# Buffer
Stability: 3 - Stable
Stability: 2 - Stable
Pure JavaScript is Unicode friendly but not nice to binary data. When
dealing with TCP streams or the file system, it's necessary to handle octet

2
doc/api/child_process.markdown
View File

@ -1,6 +1,6 @@
# Child Process
Stability: 3 - Stable
Stability: 2 - Stable
io.js provides a tri-directional `popen(3)` facility through the
`child_process` module.

2
doc/api/cluster.markdown
View File

@ -1,6 +1,6 @@
# Cluster
Stability: 2 - Unstable
Stability: 2 - Stable
A single instance of io.js runs in a single thread. To take advantage of
multi-core systems the user will sometimes want to launch a cluster of io.js

2
doc/api/console.markdown
View File

@ -1,6 +1,6 @@
# console
Stability: 4 - API Frozen
Stability: 2 - Stable
* {Object}

3
doc/api/crypto.markdown
View File

@ -1,7 +1,6 @@
# Crypto
Stability: 2 - Unstable; API changes are being discussed for
future versions. Breaking changes will be minimized. See below.
Stability: 2 - Stable
Use `require('crypto')` to access this module.

2
doc/api/debugger.markdown
View File

@ -1,6 +1,6 @@
# Debugger
Stability: 3 - Stable
Stability: 2 - Stable
<!-- type=misc -->

2
doc/api/dgram.markdown
View File

@ -1,6 +1,6 @@
# UDP / Datagram Sockets
Stability: 3 - Stable
Stability: 2 - Stable
<!-- name=dgram -->

2
doc/api/dns.markdown
View File

@ -1,6 +1,6 @@
# DNS
Stability: 3 - Stable
Stability: 2 - Stable
Use `require('dns')` to access this module.

30
doc/api/documentation.markdown
View File

@ -42,34 +42,20 @@ compatibility should not be expected.
```
Stability: 1 - Experimental
This feature was introduced recently, and may change
or be removed in future versions. Please try it out and provide feedback.
If it addresses a use-case that is important to you, tell the node core team.
This feature is subject to change, and is gated by a command line flag.
It may change or be removed in future versions.
```
```
Stability: 2 - Unstable
The API is in the process of settling, but has not yet had
sufficient real-world testing to be considered stable. Backwards-compatibility
will be maintained if reasonable.
Stability: 2 - Stable
The API has proven satisfactory. Compatibility with the npm ecosystem
is a high priority, and will not be broken unless absolutely necessary.
```
```
Stability: 3 - Stable
The API has proven satisfactory, but cleanup in the underlying
code may cause minor changes. Backwards-compatibility is guaranteed.
```
```
Stability: 4 - API Frozen
This API has been tested extensively in production and is
unlikely to ever have to change.
```
```
Stability: 5 - Locked
Unless serious bugs are found, this code will not ever
change. Please do not suggest changes in this area; they will be refused.
Stability: 3 - Locked
Only fixes related to security, performance, or bug fixes will be accepted.
Please do not suggest API changes in this area; they will be refused.
```
## JSON Output

2
doc/api/domain.markdown
View File

@ -1,6 +1,6 @@
# Domain
Stability: 2 - Unstable
Stability: 0 - Deprecated
**This module is pending deprecation**. Once a replacement API has been
finalized, this module will be fully deprecated. Most end users should

2
doc/api/events.markdown
View File

@ -1,6 +1,6 @@
# Events
Stability: 4 - API Frozen
Stability: 2 - Stable
<!--type=module-->

2
doc/api/fs.markdown
View File

@ -1,6 +1,6 @@
# File System
Stability: 3 - Stable
Stability: 2 - Stable
<!--name=fs-->

2
doc/api/http.markdown
View File

@ -1,6 +1,6 @@
# HTTP
Stability: 3 - Stable
Stability: 2 - Stable
To use the HTTP server and client one must `require('http')`.

2
doc/api/https.markdown
View File

@ -1,6 +1,6 @@
# HTTPS
Stability: 3 - Stable
Stability: 2 - Stable
HTTPS is the HTTP protocol over TLS/SSL. In io.js this is implemented as a
separate module.

2
doc/api/modules.markdown
View File

@ -1,6 +1,6 @@
# Modules
Stability: 5 - Locked
Stability: 3 - Locked
<!--name=module-->

2
doc/api/net.markdown
View File

@ -1,6 +1,6 @@
# net
Stability: 3 - Stable
Stability: 2 - 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

2
doc/api/os.markdown
View File

@ -1,6 +1,6 @@
# OS
Stability: 4 - API Frozen
Stability: 2 - Stable
Provides a few basic operating-system related utility functions.

2
doc/api/path.markdown
View File

@ -1,6 +1,6 @@
# Path
Stability: 3 - Stable
Stability: 2 - Stable
This module contains utilities for handling and transforming file
paths. Almost all these methods perform only string transformations.

2
doc/api/punycode.markdown
View File

@ -1,6 +1,6 @@
# punycode
Stability: 3 - Stable
Stability: 2 - Stable
[Punycode.js](https://mths.be/punycode) is bundled with io.js v1.0.0+ and
Node.js v0.6.2+. Use `require('punycode')` to access it. (To use it with

2
doc/api/querystring.markdown
View File

@ -1,6 +1,6 @@
# Query String
Stability: 3 - Stable
Stability: 2 - Stable
<!--name=querystring-->

2
doc/api/readline.markdown
View File

@ -1,6 +1,6 @@
# Readline
Stability: 2 - Unstable
Stability: 2 - Stable
To use this module, do `require('readline')`. Readline allows reading of a
stream (such as `process.stdin`) on a line-by-line basis.

2
doc/api/repl.markdown
View File

@ -1,6 +1,6 @@
# REPL
Stability: 3 - Stable
Stability: 2 - Stable
A Read-Eval-Print-Loop (REPL) is available both as a standalone program and
easily includable in other programs. The REPL provides a way to interactively

2
doc/api/smalloc.markdown
View File

@ -1,6 +1,6 @@
# Smalloc
Stability: 1 - Experimental
Stability: 2 - Stable
## Class: smalloc

2
doc/api/stream.markdown
View File

@ -1,6 +1,6 @@
# Stream
Stability: 2 - Unstable
Stability: 2 - Stable
A stream is an abstract interface implemented by various objects in
io.js. For example a [request to an HTTP

2
doc/api/string_decoder.markdown
View File

@ -1,6 +1,6 @@
# StringDecoder
Stability: 3 - Stable
Stability: 2 - Stable
To use this module, do `require('string_decoder')`. StringDecoder decodes a
buffer to a string. It is a simple interface to `buffer.toString()` but provides

2
doc/api/timers.markdown
View File

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

2
doc/api/tls.markdown
View File

@ -1,6 +1,6 @@
# TLS (SSL)
Stability: 3 - Stable
Stability: 2 - Stable
Use `require('tls')` to access this module.

2
doc/api/tty.markdown
View File

@ -1,6 +1,6 @@
# TTY
Stability: 2 - Unstable
Stability: 2 - Stable
The `tty` module houses the `tty.ReadStream` and `tty.WriteStream` classes. In
most cases, you will not need to use this module directly.

2
doc/api/url.markdown
View File

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

2
doc/api/util.markdown
View File

@ -1,6 +1,6 @@
# util
Stability: 4 - API Frozen
Stability: 2 - Stable
These functions are in the module `'util'`. Use `require('util')` to
access them.

2
doc/api/v8.markdown
View File

@ -1,6 +1,6 @@
# V8
Stability: 1 - Experimental
Stability: 2 - Stable
This module exposes events and interfaces specific to the version of [V8][]
built with io.js. These interfaces are subject to change by upstream and are

2
doc/api/vm.markdown
View File

@ -1,6 +1,6 @@
# Executing JavaScript
Stability: 3 - Stable
Stability: 2 - Stable
<!--name=vm-->

2
doc/api/zlib.markdown
View File

@ -1,6 +1,6 @@
# Zlib
Stability: 3 - Stable
Stability: 2 - Stable
You can access this module with:

10
doc/api_assets/style.css
View File

@ -88,18 +88,10 @@ code a:hover {
}
.api_stability_2 {
background-color: #FFA000;
background-color: #4EBA0F;
}
.api_stability_3 {
background-color: #AEC516;
}
.api_stability_4 {
background-color: #009431;
}
.api_stability_5 {
background-color: #0084B6;
}