Skip to content

doc: demonstrate the dangers of buffer.slice() #41627

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

Closed
wants to merge 1 commit into from
Closed

doc: demonstrate the dangers of buffer.slice() #41627

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3427,6 +3427,15 @@ console.log(copiedBuf.toString());

console.log(buf.toString());
// Prints: buffer

// With buffer.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
Expand All @@ -3441,6 +3450,15 @@ console.log(copiedBuf.toString());

console.log(buf.toString());
// Prints: buffer

// With buffer.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()`
Expand Down