lukechilds
/
node
mirror of https://github.com/lukechilds/node.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

doc: fix return value of write methods 

Fixes: https:github.com/nodejs/node/issues/5682
PR-URL: https://github.com/nodejs/node/pull/5736
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
process-exit-stdio-flushing
Felix Böhm 9 years ago
committed by James M Snell
parent
f9e6191f85
commit
939d6efe0f
1 changed files with 10 additions and 10 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 20
      doc/api/buffer.markdown

20
doc/api/buffer.markdown
View File

@ -1355,7 +1355,7 @@ console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
* `value` {Number} Bytes to be written to Buffer * `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 8` * `offset` {Number} `0 <= offset <= buf.length - 8`
* `noAssert` {Boolean} Default: false * `noAssert` {Boolean} Default: false
* Return: {Number} Numbers of bytes written * Return: {Number} The offset plus the number of written bytes
Writes `value` to the Buffer at the specified `offset` with specified endian Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeDoubleBE()` writes big endian, `writeDoubleLE()` writes little format (`writeDoubleBE()` writes big endian, `writeDoubleLE()` writes little
@ -1387,7 +1387,7 @@ console.log(buf);
* `value` {Number} Bytes to be written to Buffer * `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 4` * `offset` {Number} `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Default: false * `noAssert` {Boolean} Default: false
* Return: {Number} Numbers of bytes written * Return: {Number} The offset plus the number of written bytes
Writes `value` to the Buffer at the specified `offset` with specified endian Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeFloatBE()` writes big endian, `writeFloatLE()` writes little format (`writeFloatBE()` writes big endian, `writeFloatLE()` writes little
@ -1419,7 +1419,7 @@ console.log(buf);
* `value` {Number} Bytes to be written to Buffer * `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 1` * `offset` {Number} `0 <= offset <= buf.length - 1`
* `noAssert` {Boolean} Default: false * `noAssert` {Boolean} Default: false
* Return: {Number} Numbers of bytes written * Return: {Number} The offset plus the number of written bytes
Writes `value` to the Buffer at the specified `offset`. The `value` must be a Writes `value` to the Buffer at the specified `offset`. The `value` must be a
valid signed 8-bit integer. valid signed 8-bit integer.
@ -1445,7 +1445,7 @@ console.log(buf);
* `value` {Number} Bytes to be written to Buffer * `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 2` * `offset` {Number} `0 <= offset <= buf.length - 2`
* `noAssert` {Boolean} Default: false * `noAssert` {Boolean} Default: false
* Return: {Number} Numbers of bytes written * Return: {Number} The offset plus the number of written bytes
Writes `value` to the Buffer at the specified `offset` with specified endian Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeInt16BE()` writes big endian, `writeInt16LE()` writes little format (`writeInt16BE()` writes big endian, `writeInt16LE()` writes little
@ -1472,7 +1472,7 @@ console.log(buf);
* `value` {Number} Bytes to be written to Buffer * `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 4` * `offset` {Number} `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Default: false * `noAssert` {Boolean} Default: false
* Return: {Number} Numbers of bytes written * Return: {Number} The offset plus the number of written bytes
Writes `value` to the Buffer at the specified `offset` with specified endian Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeInt32BE()` writes big endian, `writeInt32LE()` writes little format (`writeInt32BE()` writes big endian, `writeInt32LE()` writes little
@ -1500,7 +1500,7 @@ console.log(buf);
* `offset` {Number} `0 <= offset <= buf.length - byteLength` * `offset` {Number} `0 <= offset <= buf.length - byteLength`
* `byteLength` {Number} `0 < byteLength <= 6` * `byteLength` {Number} `0 < byteLength <= 6`
* `noAssert` {Boolean} Default: false * `noAssert` {Boolean} Default: false
* Return: {Number} Numbers of bytes written * Return: {Number} The offset plus the number of written bytes
Writes `value` to the Buffer at the specified `offset` and `byteLength`. Writes `value` to the Buffer at the specified `offset` and `byteLength`.
Supports up to 48 bits of accuracy. For example: Supports up to 48 bits of accuracy. For example:
@ -1527,7 +1527,7 @@ should not be used unless you are certain of correctness.
* `value` {Number} Bytes to be written to Buffer * `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 1` * `offset` {Number} `0 <= offset <= buf.length - 1`
* `noAssert` {Boolean} Default: false * `noAssert` {Boolean} Default: false
* Return: {Number} Numbers of bytes written * Return: {Number} The offset plus the number of written bytes
Writes `value` to the Buffer at the specified `offset`. The `value` must be a Writes `value` to the Buffer at the specified `offset`. The `value` must be a
valid unsigned 8-bit integer. valid unsigned 8-bit integer.
@ -1556,7 +1556,7 @@ console.log(buf);
* `value` {Number} Bytes to be written to Buffer * `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 2` * `offset` {Number} `0 <= offset <= buf.length - 2`
* `noAssert` {Boolean} Default: false * `noAssert` {Boolean} Default: false
* Return: {Number} Numbers of bytes written * Return: {Number} The offset plus the number of written bytes
Writes `value` to the Buffer at the specified `offset` with specified endian Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeUInt16BE()` writes big endian, `writeUInt16LE()` writes little format (`writeUInt16BE()` writes big endian, `writeUInt16LE()` writes little
@ -1590,7 +1590,7 @@ console.log(buf);
* `value` {Number} Bytes to be written to Buffer * `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 4` * `offset` {Number} `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Default: false * `noAssert` {Boolean} Default: false
* Return: {Number} Numbers of bytes written * Return: {Number} The offset plus the number of written bytes
Writes `value` to the Buffer at the specified `offset` with specified endian Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeUInt32BE()` writes big endian, `writeUInt32LE()` writes little format (`writeUInt32BE()` writes big endian, `writeUInt32LE()` writes little
@ -1623,7 +1623,7 @@ console.log(buf);
* `offset` {Number} `0 <= offset <= buf.length - byteLength` * `offset` {Number} `0 <= offset <= buf.length - byteLength`
* `byteLength` {Number} `0 < byteLength <= 6` * `byteLength` {Number} `0 < byteLength <= 6`
* `noAssert` {Boolean} Default: false * `noAssert` {Boolean} Default: false
* Return: {Number} Numbers of bytes written * Return: {Number} The offset plus the number of written bytes
Writes `value` to the Buffer at the specified `offset` and `byteLength`. Writes `value` to the Buffer at the specified `offset` and `byteLength`.
Supports up to 48 bits of accuracy. For example: Supports up to 48 bits of accuracy. For example:

Write Preview
Loading…
Cancel
Save