doc: clarify out-of-bounds behavior of buf[index]

PR-URL: nodejs/node#11286 Fixes: nodejs/node#11244 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Ron Korving <[email protected]>
michielbaird · Jul 19, 2017 · ad978a7 · ad978a7
1 parent 850d36e
commit ad978a7
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
@@ -872,6 +872,10 @@ The index operator `[index]` can be used to get and set the octet at position
 `index` in `buf`. The values refer to individual bytes, so the legal value
 range is between `0x00` and `0xFF` (hex) or `0` and `255` (decimal).
 
+This operator is inherited from `Uint8Array`, so its behavior on out-of-bounds
+access is the same as `UInt8Array` - that is, getting returns `undefined` and
+setting does nothing.
+
 Example: Copy an ASCII string into a `Buffer`, one byte at a time
 
 ```js