Skip to content

V5.10.1 proposal #6060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MylesBorins merged 30 commits into from
Apr 5, 2016
Merged

V5.10.1 proposal #6060

Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
f3f19ee
net: refactor self=this to arrow functions
benjamingr Mar 23, 2016
0a13099
etw: add event messages
joaocgreis Mar 21, 2016
f14d71c
test: stdin is not always a net.Socket
Fishrock123 Mar 28, 2016
4f1fa2a
test: fix offending max-len linter error
thefourtheye Mar 31, 2016
96bb315
test: ensure _handle property existence
Trott Mar 26, 2016
c6ac6f2
http: Corrects IPv6 address in Host header
mpotra Feb 19, 2016
3f75751
build: introduce ci targets for lint/benchmark
jbergstroem Mar 27, 2016
a40b0cb
test: refactor http-end-throw-socket-handling
santigimeno Mar 12, 2016
8bec8aa
doc: consolidate timers docs in timers.markdown
bengl Mar 21, 2016
0ae5d02
doc: clarify that __dirname is module local
jasnell Apr 2, 2016
7337ef6
doc: minor argument formatting in stream.markdown
jasnell Apr 2, 2016
7491fdc
tools: remove disabling of already-disabled rule
Trott Apr 2, 2016
ce17371
doc: add 'Command Line Options' to 'View on single page'
firedfox Apr 2, 2016
f12c386
doc: clarify stdout/stderr arguments to callback
jasnell Apr 2, 2016
f879f5e
doc: document unspecified behavior for buf.write* methods
jasnell Mar 27, 2016
6052ced
test: fix error message checks in test-module-loading
jasnell Apr 1, 2016
0127c2b
test: fix test-dns.js flakiness
Trott Apr 1, 2016
dd25984
doc: note assert.throws() pitfall
Trott Apr 3, 2016
2ab1237
test: fix flaky test-net-socket-timeout-unref
Trott Mar 29, 2016
aa9fb03
doc: use HTTPS for links where possible
Trott Apr 2, 2016
1c40079
path: fix win32.isAbsolute() inconsistency
mscdex Apr 3, 2016
02f2ebd
test: explicitly set global in test-repl
Trott Apr 3, 2016
7db7a82
test: make arch available in status files
santigimeno Apr 1, 2016
cc8fcc5
test: be explicit about polluting of `global`
Trott Apr 2, 2016
059b607
test: make use of globals explicit
Trott Apr 2, 2016
0f5a51a
assert: Check typed array view type in deepEqual
addaleax Mar 26, 2016
50a062e
tools: remove obsolete lint config file
Trott Mar 30, 2016
8317778
meta: add "joining a wg" section to WORKING_GROUPS.md
mcollina Feb 29, 2016
781290b
doc: refine child_process detach behaviour
eljefedelrodeodeljefe Feb 19, 2016
5c4a414
2016-04-05, Version 5.10.1 (Stable) Release
Apr 5, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: document unspecified behavior for buf.write* methods 
Per #1161, when the
buf.write*() methods are given anything other than what
they expect, indicate that the behavior is unspecified.

Fixes: #1161
PR-URL: #5925
Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
  • Loading branch information
@jasnell
jasnell authored and Myles Borins committed Apr 5, 2016
commit f879f5e68aa4d1ba25fa5c09200e0115190b54dd
31 changes: 21 additions & 10 deletions doc/api/buffer.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1384,7 +1384,8 @@ console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);

Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeDoubleBE()` writes big endian, `writeDoubleLE()` writes little
endian). The `value` argument must be a valid 64-bit double.
endian). The `value` argument *should* be a valid 64-bit double. Behavior is
not defined when `value` is anything other than a 64-bit double.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
Expand Down Expand Up @@ -1416,7 +1417,7 @@ console.log(buf);

Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeFloatBE()` writes big endian, `writeFloatLE()` writes little
endian). Behavior is unspecified if `value` is anything other than a 32-bit
endian). Behavior is not defined when `value` is anything other than a 32-bit
float.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
Expand Down Expand Up @@ -1446,8 +1447,9 @@ console.log(buf);
* `noAssert` {Boolean} Default: false
* Return: {Number} The offset plus the number of written bytes

Writes `value` to the Buffer at the specified `offset`. The `value` must be a
valid signed 8-bit integer.
Writes `value` to the Buffer at the specified `offset`. The `value` should be a
valid signed 8-bit integer. Behavior is not defined when `value` is anything
other than a signed 8-bit integer.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
Expand All @@ -1474,7 +1476,8 @@ console.log(buf);

Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeInt16BE()` writes big endian, `writeInt16LE()` writes little
endian). The `value` must be a valid signed 16-bit integer.
endian). The `value` should be a valid signed 16-bit integer. Behavior is
not defined when `value` is anything other than a signed 16-bit integer.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
Expand All @@ -1501,7 +1504,8 @@ console.log(buf);

Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeInt32BE()` writes big endian, `writeInt32LE()` writes little
endian). The `value` must be a valid signed 32-bit integer.
endian). The `value` should be a valid signed 32-bit integer. Behavior is
not defined when `value` is anything other than a signed 32-bit integer.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
Expand Down Expand Up @@ -1547,15 +1551,18 @@ that `value` may be too large for the specific function and `offset` may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.

Behavior is not defined when `value` is anything other than an integer.

### buf.writeUInt8(value, offset[, noAssert])

* `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 1`
* `noAssert` {Boolean} Default: false
* Return: {Number} The offset plus the number of written bytes

Writes `value` to the Buffer at the specified `offset`. The `value` must be a
valid unsigned 8-bit integer.
Writes `value` to the Buffer at the specified `offset`. The `value` should be a
valid unsigned 8-bit integer. Behavior is not defined when `value` is anything
other than an unsigned 8-bit integer.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
Expand Down Expand Up @@ -1585,7 +1592,8 @@ console.log(buf);

Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeUInt16BE()` writes big endian, `writeUInt16LE()` writes little
endian). The `value` must be a valid unsigned 16-bit integer.
endian). The `value` should be a valid unsigned 16-bit integer. Behavior is
not defined when `value` is anything other than an unsigned 16-bit integer.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
Expand Down Expand Up @@ -1619,7 +1627,8 @@ console.log(buf);

Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeUInt32BE()` writes big endian, `writeUInt32LE()` writes little
endian). The `value` must be a valid unsigned 32-bit integer.
endian). The `value` should be a valid unsigned 32-bit integer. Behavior is
not defined when `value` is anything other than an unsigned 32-bit integer.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
Expand Down Expand Up @@ -1665,6 +1674,8 @@ that `value` may be too large for the specific function and `offset` may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.

Behavior is not defined when `value` is anything other than an unsigned integer.

## buffer.INSPECT_MAX_BYTES

* {Number} Default: 50
Expand Down