@@ -11,20 +11,16 @@ Where appropriate, property types, method arguments, and the arguments
11
11
provided to event handlers are detailed in a list underneath the topic
12
12
heading.
13
13
14
- Every ` .html ` document has a corresponding ` .json ` document presenting
15
- the same information in a structured manner. This feature is
16
- experimental, and added for the benefit of IDEs and other utilities that
17
- wish to do programmatic things with the documentation.
18
-
19
- Every ` .html ` and ` .json ` file is generated based on the corresponding
20
- ` .md ` file in the ` doc/api/ ` folder in Node.js's source tree. The
21
- documentation is generated using the ` tools/doc/generate.js ` program.
22
- The HTML template is located at ` doc/template.html ` .
23
-
14
+ ## Contributing
24
15
25
16
If errors are found in this documentation, please [ submit an issue] [ ]
26
17
or see [ the contributing guide] [ ] for directions on how to submit a patch.
27
18
19
+ Every file is generated based on the corresponding ` .md ` file in the
20
+ ` doc/api/ ` folder in Node.js's source tree. The documentation is generated
21
+ using the ` tools/doc/generate.js ` program. An HTML template is located at
22
+ ` doc/template.html ` .
23
+
28
24
## Stability Index
29
25
30
26
<!-- type=misc-->
@@ -53,40 +49,43 @@ is not recommended in production environments. Experimental features are not
53
49
subject to the Node.js Semantic Versioning model.
54
50
```
55
51
56
- * Note* : Caution must be used when making use of ` Experimental ` features,
57
- particularly within modules that may be used as dependencies (or dependencies
58
- of dependencies) within a Node.js application. End users may not be aware that
59
- experimental features are being used, and therefore may experience unexpected
60
- failures or behavioral changes when changes occur. To help avoid such surprises,
61
- ` Experimental ` features may require a command-line flag to explicitly enable
62
- them, or may cause a process warning to be emitted. By default, such warnings
63
- are printed to ` stderr ` and may be handled by attaching a listener to the
64
- ` process.on('warning') ` event.
65
-
66
52
``` txt
67
53
Stability: 2 - Stable
68
54
The API has proven satisfactory. Compatibility with the npm ecosystem
69
55
is a high priority, and will not be broken unless absolutely necessary.
70
56
```
71
57
58
+ * Note* : Caution must be used when making use of ` Experimental ` features,
59
+ particularly within modules that may be used as dependencies (or dependencies
60
+ of dependencies) within a Node.js application. End users may not be aware that
61
+ experimental features are being used, and therefore may experience unexpected
62
+ failures or behavior changes when API modifications occur. To help avoid such
63
+ surprises, ` Experimental ` features may require a command-line flag to
64
+ explicitly enable them, or may cause a process warning to be emitted.
65
+ By default, such warnings are printed to [ ` stderr ` ] [ ] and may be handled by
66
+ attaching a listener to the [ ` process.on('warning') ` ] [ ] event.
67
+
72
68
## JSON Output
69
+ <!-- YAML
70
+ added: v0.6.12
71
+ -->
73
72
74
73
> Stability: 1 - Experimental
75
74
76
- Every HTML file in the markdown has a corresponding JSON file with the
77
- same data.
78
-
79
- This feature was added in Node.js v0.6.12. It is experimental .
75
+ Every ` .html ` document has a corresponding ` .json ` document presenting
76
+ the same information in a structured manner. This feature is
77
+ experimental, and added for the benefit of IDEs and other utilities that
78
+ wish to do programmatic things with the documentation .
80
79
81
80
## Syscalls and man pages
82
81
83
82
System calls like open(2) and read(2) define the interface between user programs
84
83
and the underlying operating system. Node functions which simply wrap a syscall,
85
- like ` fs.open() ` , will document that. The docs link to the corresponding man
84
+ like [ ` fs.open() ` ] [ ] , will document that. The docs link to the corresponding man
86
85
pages (short for manual pages) which describe how the syscalls work.
87
86
88
- ** Note: ** some syscalls, like lchown(2), are BSD-specific. That means, for
89
- example, that ` fs.lchown() ` only works on macOS and other BSD-derived systems,
87
+ Some syscalls, like lchown(2), are BSD-specific. That means, for
88
+ example, that [ ` fs.lchown() ` ] [ ] only works on macOS and other BSD-derived systems,
90
89
and is not available on Linux.
91
90
92
91
Most Unix syscalls have Windows equivalents, but behavior may differ on Windows
@@ -96,3 +95,7 @@ issue 4760](https://github.com/nodejs/node/issues/4760).
96
95
97
96
[ submit an issue ] : https://github.com/nodejs/node/issues/new
98
97
[ the contributing guide ] : https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
98
+ [ `stderr` ] : process.html#process_process_stderr
99
+ [ `process.on('warning')` ] : process.html#process_event_warning
100
+ [ `fs.open()` ] : fs.html#fs_fs_open_path_flags_mode_callback
101
+ [ `fs.lchown()` ] : fs.html#fs_fs_lchown_path_uid_gid_callback
0 commit comments