doc: demonstrate dangers of buffer.slice()

PR-URL: #41628 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Rich Trott <[email protected]>
nodejs · Jan 24, 2022 · 174155d · 174155d
1 parent 57ada37
commit 174155d
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
@@ -3425,6 +3425,14 @@ console.log(copiedBuf.toString());
 
 console.log(buf.toString());
 // Prints: buffer
+
+// With buf.slice(), the original buffer is modified.
+const notReallyCopiedBuf = buf.slice();
+notReallyCopiedBuf[0]++;
+console.log(notReallyCopiedBuf.toString());
+// Prints: cuffer
+console.log(buf.toString());
+// Also prints: cuffer (!)
 ```
 
 ```cjs
@@ -3439,6 +3447,14 @@ console.log(copiedBuf.toString());
 
 console.log(buf.toString());
 // Prints: buffer
+
+// With buf.slice(), the original buffer is modified.
+const notReallyCopiedBuf = buf.slice();
+notReallyCopiedBuf[0]++;
+console.log(notReallyCopiedBuf.toString());
+// Prints: cuffer
+console.log(buf.toString());
+// Also prints: cuffer (!)
 ```
 
 ### `buf.swap16()`