Skip to content

Commit

Permalink
doc: fix doc for Buffer.readInt32LE()
Browse files Browse the repository at this point in the history
Update example of readInt32LE method. buf.readInt32LE(1) is supposed to
throw an error as it has only four elements and it tries to read 32
bits from three bytes.

Fixes: #5889
PR-URL: #5890
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Sakthipriyan Vairamani <[email protected]>
  • Loading branch information
ghaiklor authored and Myles Borins committed Apr 8, 2016
1 parent d275cdf commit 6e2bfbe
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/api/buffer.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -739,8 +739,10 @@ const buf = new Buffer([1,-2,3,4]);

buf.readInt32BE();
// returns 33424132
buf.readInt32LE(1);
buf.readInt32LE();
// returns 67370497
buf.readInt32LE(1);
// throws RangeError: Index out of range
```

### buf.readIntBE(offset, byteLength[, noAssert])
Expand Down

0 comments on commit 6e2bfbe

Please sign in to comment.