doc: fix doc for Buffer.readInt32LE()

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]>
nodejs · Apr 8, 2016 · 6e2bfbe · 6e2bfbe
1 parent d275cdf
commit 6e2bfbe
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/doc/api/buffer.markdown b/doc/api/buffer.markdown
@@ -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])