Skip to content
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

doc: document use of buffer.swap16() for utf16be #23747

Closed
wants to merge 5 commits into from
Closed

doc: document use of buffer.swap16() for utf16be #23747

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d358f34
doc: document use of buffer.swap16() for utf16be
jasnell Oct 19, 2018
3e3c7cc
[Squash] nit
vsemozhetbyt Oct 19, 2018
f83ff61
[Squash] nit
vsemozhetbyt Oct 19, 2018
d9d9c38
[Squash] nit
lpinca Oct 19, 2018
984c668
[Squash] nit
jasnell Oct 19, 2018
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
8 changes: 8 additions & 0 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1936,6 +1936,14 @@ buf2.swap16();
// Throws ERR_INVALID_BUFFER_SIZE
```

One convenient use of `buf.swap16()` is to perform a fast *in-place* conversion
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: remove italics?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Go for it :)

jasnell marked this conversation as resolved.
Show resolved Hide resolved
between UTF-16 little-endian and UTF16 big-endian:
jasnell marked this conversation as resolved.
Show resolved Hide resolved

```js
const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
buf.swap16(); // Convert to big-endian UTF-16 text.
```

### buf.swap32()
<!-- YAML
added: v5.10.0
Expand Down