Browse Source

doc: update stability index

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>
v1.8.0-commit
Chris Dickinson 10 years ago
parent
commit
cf0306cd71
  1. 2
      doc/api/assert.markdown
  2. 2
      doc/api/buffer.markdown
  3. 2
      doc/api/child_process.markdown
  4. 2
      doc/api/cluster.markdown
  5. 2
      doc/api/console.markdown
  6. 3
      doc/api/crypto.markdown
  7. 2
      doc/api/debugger.markdown
  8. 2
      doc/api/dgram.markdown
  9. 2
      doc/api/dns.markdown
  10. 30
      doc/api/documentation.markdown
  11. 2
      doc/api/domain.markdown
  12. 2
      doc/api/events.markdown
  13. 2
      doc/api/fs.markdown
  14. 2
      doc/api/http.markdown
  15. 2
      doc/api/https.markdown
  16. 2
      doc/api/modules.markdown
  17. 2
      doc/api/net.markdown
  18. 2
      doc/api/os.markdown
  19. 2
      doc/api/path.markdown
  20. 2
      doc/api/punycode.markdown
  21. 2
      doc/api/querystring.markdown
  22. 2
      doc/api/readline.markdown
  23. 2
      doc/api/repl.markdown
  24. 2
      doc/api/smalloc.markdown
  25. 2
      doc/api/stream.markdown
  26. 2
      doc/api/string_decoder.markdown
  27. 2
      doc/api/timers.markdown
  28. 2
      doc/api/tls.markdown
  29. 2
      doc/api/tty.markdown
  30. 2
      doc/api/url.markdown
  31. 2
      doc/api/util.markdown
  32. 2
      doc/api/v8.markdown
  33. 2
      doc/api/vm.markdown
  34. 2
      doc/api/zlib.markdown
  35. 10
      doc/api_assets/style.css

2
doc/api/assert.markdown

@ -1,6 +1,6 @@
# Assert # Assert
Stability: 5 - Locked Stability: 2 - Stable
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/buffer.markdown

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

2
doc/api/child_process.markdown

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

2
doc/api/cluster.markdown

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

2
doc/api/console.markdown

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

3
doc/api/crypto.markdown

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

2
doc/api/debugger.markdown

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

2
doc/api/dgram.markdown

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

2
doc/api/dns.markdown

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

30
doc/api/documentation.markdown

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

2
doc/api/domain.markdown

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

2
doc/api/events.markdown

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

2
doc/api/fs.markdown

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

2
doc/api/http.markdown

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

2
doc/api/https.markdown

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

2
doc/api/modules.markdown

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

2
doc/api/net.markdown

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

2
doc/api/os.markdown

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

2
doc/api/path.markdown

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

2
doc/api/punycode.markdown

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

2
doc/api/querystring.markdown

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

2
doc/api/readline.markdown

@ -1,6 +1,6 @@
# Readline # Readline
Stability: 2 - Unstable Stability: 2 - 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 `process.stdin`) on a line-by-line basis. stream (such as `process.stdin`) on a line-by-line basis.

2
doc/api/repl.markdown

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

2
doc/api/smalloc.markdown

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

2
doc/api/stream.markdown

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

2
doc/api/string_decoder.markdown

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

2
doc/api/timers.markdown

@ -1,6 +1,6 @@
# Timers # Timers
Stability: 5 - Locked Stability: 3 - 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,6 +1,6 @@
# TLS (SSL) # TLS (SSL)
Stability: 3 - Stable Stability: 2 - Stable
Use `require('tls')` to access this module. Use `require('tls')` to access this module.

2
doc/api/tty.markdown

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

2
doc/api/url.markdown

@ -1,6 +1,6 @@
# URL # URL
Stability: 3 - Stable Stability: 2 - 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,6 +1,6 @@
# util # util
Stability: 4 - API Frozen Stability: 2 - Stable
These functions are in the module `'util'`. Use `require('util')` to These functions are in the module `'util'`. Use `require('util')` to
access them. access them.

2
doc/api/v8.markdown

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

2
doc/api/vm.markdown

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

2
doc/api/zlib.markdown

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

10
doc/api_assets/style.css

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

Loading…
Cancel
Save