@@ -39,20 +39,29 @@ The stability indices are as follows:
39
39
40
40
``` txt
41
41
Stability: 0 - Deprecated
42
- This feature is known to be problematic, and changes are planned. Do
42
+ This feature is known to be problematic, and changes may be planned. Do
43
43
not rely on it. Use of the feature may cause warnings to be emitted.
44
- Backwards compatibility should not be expected.
44
+ Backwards compatibility across major versions should not be expected.
45
45
```
46
46
47
47
``` txt
48
48
Stability: 1 - Experimental
49
49
This feature is still under active development and subject to non-backwards
50
50
compatible changes, or even removal, in any future version. Use of the feature
51
- is not recommended in production environments. The feature may only be usable
52
- after using a command-line flag to enable it. Use of the feature may cause
53
- warnings to be emitted.
51
+ is not recommended in production environments. Experimental features are not
52
+ subject to the Node.js Semantic Versioning model.
54
53
```
55
54
55
+ * Note* : Caution must be used when making use of ` Experimental ` features,
56
+ particularly within modules that may be used as dependencies (or dependencies
57
+ of dependencies) within a Node.js application. End users may not be aware that
58
+ experimental features are being used, and therefore may experience unexpected
59
+ failures or behavioral changes when changes occur. To help avoid such surprises,
60
+ ` Experimental ` features may require a command-line flag to explicitly enable
61
+ them, or may cause a process warning to be emitted. By default, such warnings
62
+ are printed to ` stderr ` and may be handled by attaching a listener to the
63
+ ` process.on('warning') ` event.
64
+
56
65
``` txt
57
66
Stability: 2 - Stable
58
67
The API has proven satisfactory. Compatibility with the npm ecosystem
0 commit comments