Skip to content

Commit 889a49f

Browse files
committed
doc: document use of buffer.swap16() for utf16be
Fixes: #12813 PR-URL: #23747 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent 24e79bd commit 889a49f

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

doc/api/buffer.md

+8
Original file line numberDiff line numberDiff line change
@@ -1936,6 +1936,14 @@ buf2.swap16();
19361936
// Throws ERR_INVALID_BUFFER_SIZE
19371937
```
19381938

1939+
One convenient use of `buf.swap16()` is to perform a fast in-place conversion
1940+
between UTF-16 little-endian and UTF-16 big-endian:
1941+
1942+
```js
1943+
const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
1944+
buf.swap16(); // Convert to big-endian UTF-16 text.
1945+
```
1946+
19391947
### buf.swap32()
19401948
<!-- YAML
19411949
added: v5.10.0

0 commit comments

Comments
 (0)