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

doc: unify property sections

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/19869
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit is contained in:
Vse Mozhet Byt 2018-04-07 15:23:10 +03:00
parent 53035b142b
commit 08a36a0666
3 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
doc/api/fs.md
View File

@ -368,7 +368,7 @@ Emitted when the `fs.ReadStream`'s file descriptor has been opened.
added: v6.4.0 added: v6.4.0
--> -->
* Value: {number} * {number}
The number of bytes that have been read so far. The number of bytes that have been read so far.
@ -377,7 +377,7 @@ The number of bytes that have been read so far.
added: v0.1.93 added: v0.1.93
--> -->
* Value: {string|Buffer} * {string|Buffer}
The path to the file the stream is reading from as specified in the first The path to the file the stream is reading from as specified in the first
argument to `fs.createReadStream()`. If `path` is passed as a string, then argument to `fs.createReadStream()`. If `path` is passed as a string, then
@ -488,61 +488,61 @@ This method is only valid when using [`fs.lstat()`][]
### stats.dev ### stats.dev
* Value: {number} * {number}
The numeric identifier of the device containing the file. The numeric identifier of the device containing the file.
### stats.ino ### stats.ino
* Value: {number} * {number}
The file system specific "Inode" number for the file. The file system specific "Inode" number for the file.
### stats.mode ### stats.mode
* Value: {number} * {number}
A bit-field describing the file type and mode. A bit-field describing the file type and mode.
### stats.nlink ### stats.nlink
* Value: {number} * {number}
The number of hard-links that exist for the file. The number of hard-links that exist for the file.
### stats.uid ### stats.uid
* Value: {number} * {number}
The numeric user identifier of the user that owns the file (POSIX). The numeric user identifier of the user that owns the file (POSIX).
### stats.gid ### stats.gid
* Value: {number} * {number}
The numeric group identifier of the group that owns the file (POSIX). The numeric group identifier of the group that owns the file (POSIX).
### stats.rdev ### stats.rdev
* Value: {number} * {number}
A numeric device identifier if the file is considered "special". A numeric device identifier if the file is considered "special".
### stats.size ### stats.size
* Value: {number} * {number}
The size of the file in bytes. The size of the file in bytes.
### stats.blksize ### stats.blksize
* Value: {number} * {number}
The file system block size for i/o operations. The file system block size for i/o operations.
### stats.blocks ### stats.blocks
* Value: {number} * {number}
The number of blocks allocated for this file. The number of blocks allocated for this file.
@ -551,7 +551,7 @@ The number of blocks allocated for this file.
added: v8.1.0 added: v8.1.0
--> -->
* Value: {number} * {number}
The timestamp indicating the last time this file was accessed expressed in The timestamp indicating the last time this file was accessed expressed in
milliseconds since the POSIX Epoch. milliseconds since the POSIX Epoch.
@ -561,7 +561,7 @@ milliseconds since the POSIX Epoch.
added: v8.1.0 added: v8.1.0
--> -->
* Value: {number} * {number}
The timestamp indicating the last time this file was modified expressed in The timestamp indicating the last time this file was modified expressed in
milliseconds since the POSIX Epoch. milliseconds since the POSIX Epoch.
@ -571,7 +571,7 @@ milliseconds since the POSIX Epoch.
added: v8.1.0 added: v8.1.0
--> -->
* Value: {number} * {number}
The timestamp indicating the last time the file status was changed expressed The timestamp indicating the last time the file status was changed expressed
in milliseconds since the POSIX Epoch. in milliseconds since the POSIX Epoch.
@ -581,7 +581,7 @@ in milliseconds since the POSIX Epoch.
added: v8.1.0 added: v8.1.0
--> -->
* Value: {number} * {number}
The timestamp indicating the creation time of this file expressed in The timestamp indicating the creation time of this file expressed in
milliseconds since the POSIX Epoch. milliseconds since the POSIX Epoch.
@ -591,7 +591,7 @@ milliseconds since the POSIX Epoch.
added: v0.11.13 added: v0.11.13
--> -->
* Value: {Date} * {Date}
The timestamp indicating the last time this file was accessed. The timestamp indicating the last time this file was accessed.
@ -600,7 +600,7 @@ The timestamp indicating the last time this file was accessed.
added: v0.11.13 added: v0.11.13
--> -->
* Value: {Date} * {Date}
The timestamp indicating the last time this file was modified. The timestamp indicating the last time this file was modified.
@ -609,7 +609,7 @@ The timestamp indicating the last time this file was modified.
added: v0.11.13 added: v0.11.13
--> -->
* Value: {Date} * {Date}
The timestamp indicating the last time the file status was changed. The timestamp indicating the last time the file status was changed.
@ -618,7 +618,7 @@ The timestamp indicating the last time the file status was changed.
added: v0.11.13 added: v0.11.13
--> -->
* Value: {Date} * {Date}
The timestamp indicating the creation time of this file. The timestamp indicating the creation time of this file.
@ -3472,7 +3472,7 @@ unclosed file descriptors after a `Promise` is resolved or rejected.
added: REPLACEME added: REPLACEME
--> -->
Value: {number} The numeric file descriptor managed by the `FileHandle` object. * {number} The numeric file descriptor managed by the `FileHandle` object.
#### filehandle.appendFile(data, options) #### filehandle.appendFile(data, options)
<!-- YAML <!-- YAML

50
doc/api/http2.md
View File

@ -288,7 +288,7 @@ session.on('timeout', () => { /* .. */ });
added: v9.4.0 added: v9.4.0
--> -->
* Value: {string|undefined} * {string|undefined}
Value will be `undefined` if the `Http2Session` is not yet connected to a Value will be `undefined` if the `Http2Session` is not yet connected to a
socket, `h2c` if the `Http2Session` is not connected to a `TLSSocket`, or socket, `h2c` if the `Http2Session` is not connected to a `TLSSocket`, or
@ -315,7 +315,7 @@ If specified, the `callback` function is registered as a handler for the
added: v9.4.0 added: v9.4.0
--> -->
* Value: {boolean} * {boolean}
Will be `true` if this `Http2Session` instance has been closed, otherwise Will be `true` if this `Http2Session` instance has been closed, otherwise
`false`. `false`.
@ -346,7 +346,7 @@ If there are any remaining open `Http2Streams` associated with the
added: v8.4.0 added: v8.4.0
--> -->
* Value: {boolean} * {boolean}
Will be `true` if this `Http2Session` instance has been destroyed and must no Will be `true` if this `Http2Session` instance has been destroyed and must no
longer be used, otherwise `false`. longer be used, otherwise `false`.
@ -356,7 +356,7 @@ longer be used, otherwise `false`.
added: v9.4.0 added: v9.4.0
--> -->
* Value: {boolean|undefined} * {boolean|undefined}
Value is `undefined` if the `Http2Session` session socket has not yet been Value is `undefined` if the `Http2Session` session socket has not yet been
connected, `true` if the `Http2Session` is connected with a `TLSSocket`, connected, `true` if the `Http2Session` is connected with a `TLSSocket`,
@ -381,7 +381,7 @@ Transmits a `GOAWAY` frame to the connected peer *without* shutting down the
added: v8.4.0 added: v8.4.0
--> -->
* Value: {HTTP/2 Settings Object} * {HTTP/2 Settings Object}
A prototype-less object describing the current local settings of this A prototype-less object describing the current local settings of this
`Http2Session`. The local settings are local to *this* `Http2Session` instance. `Http2Session`. The local settings are local to *this* `Http2Session` instance.
@ -391,7 +391,7 @@ A prototype-less object describing the current local settings of this
added: v9.4.0 added: v9.4.0
--> -->
* Value: {string[]|undefined} * {string[]|undefined}
If the `Http2Session` is connected to a `TLSSocket`, the `originSet` property If the `Http2Session` is connected to a `TLSSocket`, the `originSet` property
will return an Array of origins for which the `Http2Session` may be will return an Array of origins for which the `Http2Session` may be
@ -402,7 +402,7 @@ considered authoritative.
added: v8.4.0 added: v8.4.0
--> -->
* Value: {boolean} * {boolean}
Indicates whether or not the `Http2Session` is currently waiting for an Indicates whether or not the `Http2Session` is currently waiting for an
acknowledgment for a sent SETTINGS frame. Will be `true` after calling the acknowledgment for a sent SETTINGS frame. Will be `true` after calling the
@ -460,7 +460,7 @@ instance's underlying [`net.Socket`].
added: v8.4.0 added: v8.4.0
--> -->
* Value: {HTTP/2 Settings Object} * {HTTP/2 Settings Object}
A prototype-less object describing the current remote settings of this A prototype-less object describing the current remote settings of this
`Http2Session`. The remote settings are set by the *connected* HTTP/2 peer. `Http2Session`. The remote settings are set by the *connected* HTTP/2 peer.
@ -482,7 +482,7 @@ registered as a listener on the `'timeout'` event.
added: v8.4.0 added: v8.4.0
--> -->
* Value: {net.Socket|tls.TLSSocket} * {net.Socket|tls.TLSSocket}
Returns a Proxy object that acts as a `net.Socket` (or `tls.TLSSocket`) but Returns a Proxy object that acts as a `net.Socket` (or `tls.TLSSocket`) but
limits available methods to ones safe to use with HTTP/2. limits available methods to ones safe to use with HTTP/2.
@ -503,7 +503,7 @@ added: v8.4.0
Provides miscellaneous information about the current state of the Provides miscellaneous information about the current state of the
`Http2Session`. `Http2Session`.
* Value: {Object} * {Object}
* `effectiveLocalWindowSize` {number} The current local (receive) * `effectiveLocalWindowSize` {number} The current local (receive)
flow control window size for the `Http2Session`. flow control window size for the `Http2Session`.
* `effectiveRecvDataLength` {number} The current number of bytes * `effectiveRecvDataLength` {number} The current number of bytes
@ -548,7 +548,7 @@ multiple SETTINGS frames while acknowledgment is still pending.
added: v8.4.0 added: v8.4.0
--> -->
* Value: {number} * {number}
The `http2session.type` will be equal to The `http2session.type` will be equal to
`http2.constants.NGHTTP2_SESSION_SERVER` if this `Http2Session` instance is a `http2.constants.NGHTTP2_SESSION_SERVER` if this `Http2Session` instance is a
@ -868,7 +868,7 @@ stream.on('trailers', (headers, flags) => {
added: v8.4.0 added: v8.4.0
--> -->
* Value: {boolean} * {boolean}
Set to `true` if the `Http2Stream` instance was aborted abnormally. When set, Set to `true` if the `Http2Stream` instance was aborted abnormally. When set,
the `'aborted'` event will have been emitted. the `'aborted'` event will have been emitted.
@ -878,8 +878,8 @@ the `'aborted'` event will have been emitted.
added: v8.4.0 added: v8.4.0
--> -->
* code {number} Unsigned 32-bit integer identifying the error code. **Default:** * `code` {number} Unsigned 32-bit integer identifying the error code.
`http2.constants.NGHTTP2_NO_ERROR` (`0x00`). **Default:** `http2.constants.NGHTTP2_NO_ERROR` (`0x00`).
* `callback` {Function} An optional function registered to listen for the * `callback` {Function} An optional function registered to listen for the
`'close'` event. `'close'` event.
@ -891,7 +891,7 @@ connected HTTP/2 peer.
added: v9.4.0 added: v9.4.0
--> -->
* Value: {boolean} * {boolean}
Set to `true` if the `Http2Stream` instance has been closed. Set to `true` if the `Http2Stream` instance has been closed.
@ -900,7 +900,7 @@ Set to `true` if the `Http2Stream` instance has been closed.
added: v8.4.0 added: v8.4.0
--> -->
* Value: {boolean} * {boolean}
Set to `true` if the `Http2Stream` instance has been destroyed and is no longer Set to `true` if the `Http2Stream` instance has been destroyed and is no longer
usable. usable.
@ -910,7 +910,7 @@ usable.
added: v9.4.0 added: v9.4.0
--> -->
* Value: {boolean} * {boolean}
Set to `true` if the `Http2Stream` instance has not yet been assigned a Set to `true` if the `Http2Stream` instance has not yet been assigned a
numeric stream identifier. numeric stream identifier.
@ -940,7 +940,7 @@ Updates the priority for this `Http2Stream` instance.
added: v8.4.0 added: v8.4.0
--> -->
* Value: {number} * {number}
Set to the `RST_STREAM` [error code][] reported when the `Http2Stream` is Set to the `RST_STREAM` [error code][] reported when the `Http2Stream` is
destroyed after either receiving an `RST_STREAM` frame from the connected peer, destroyed after either receiving an `RST_STREAM` frame from the connected peer,
@ -952,7 +952,7 @@ calling `http2stream.close()`, or `http2stream.destroy()`. Will be
added: v9.5.0 added: v9.5.0
--> -->
* Value: {HTTP/2 Headers Object} * {HTTP/2 Headers Object}
An object containing the outbound headers sent for this `Http2Stream`. An object containing the outbound headers sent for this `Http2Stream`.
@ -961,7 +961,7 @@ An object containing the outbound headers sent for this `Http2Stream`.
added: v9.5.0 added: v9.5.0
--> -->
* Value: {HTTP/2 Headers Object[]} * {HTTP/2 Headers Object[]}
An array of objects containing the outbound informational (additional) headers An array of objects containing the outbound informational (additional) headers
sent for this `Http2Stream`. sent for this `Http2Stream`.
@ -971,7 +971,7 @@ sent for this `Http2Stream`.
added: v9.5.0 added: v9.5.0
--> -->
* Value: {HTTP/2 Headers Object} * {HTTP/2 Headers Object}
An object containing the outbound trailers sent for this this `HttpStream`. An object containing the outbound trailers sent for this this `HttpStream`.
@ -980,7 +980,7 @@ An object containing the outbound trailers sent for this this `HttpStream`.
added: v8.4.0 added: v8.4.0
--> -->
* Value: {Http2Session} * {Http2Session}
A reference to the `Http2Session` instance that owns this `Http2Stream`. The A reference to the `Http2Session` instance that owns this `Http2Stream`. The
value will be `undefined` after the `Http2Stream` instance is destroyed. value will be `undefined` after the `Http2Stream` instance is destroyed.
@ -1010,7 +1010,7 @@ added: v8.4.0
Provides miscellaneous information about the current state of the Provides miscellaneous information about the current state of the
`Http2Stream`. `Http2Stream`.
* Value: {Object} * {Object}
* `localWindowSize` {number} The number of bytes the connected peer may send * `localWindowSize` {number} The number of bytes the connected peer may send
for this `Http2Stream` without receiving a `WINDOW_UPDATE`. for this `Http2Stream` without receiving a `WINDOW_UPDATE`.
* `state` {number} A flag indicating the low-level current state of the * `state` {number} A flag indicating the low-level current state of the
@ -1122,7 +1122,7 @@ Sends an additional informational `HEADERS` frame to the connected HTTP/2 peer.
added: v8.4.0 added: v8.4.0
--> -->
* Value: {boolean} * {boolean}
Boolean (read-only). True if headers were sent, false otherwise. Boolean (read-only). True if headers were sent, false otherwise.
@ -1131,7 +1131,7 @@ Boolean (read-only). True if headers were sent, false otherwise.
added: v8.4.0 added: v8.4.0
--> -->
* Value: {boolean} * {boolean}
Read-only property mapped to the `SETTINGS_ENABLE_PUSH` flag of the remote Read-only property mapped to the `SETTINGS_ENABLE_PUSH` flag of the remote
client's most recent `SETTINGS` frame. Will be `true` if the remote peer client's most recent `SETTINGS` frame. Will be `true` if the remote peer

6
doc/api/inspector.md
View File

@ -104,9 +104,9 @@ a front-end connected to the Inspector WebSocket port.
added: v8.0.0 added: v8.0.0
--> -->
* method {string} * `method` {string}
* params {Object} * `params` {Object}
* callback {Function} * `callback` {Function}
Posts a message to the inspector back-end. `callback` will be notified when Posts a message to the inspector back-end. `callback` will be notified when
a response is received. `callback` is a function that accepts two optional a response is received. `callback` is a function that accepts two optional