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

Fixes: #12813 PR-URL: #23747 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
nodejs · Oct 19, 2018 · ad61550 · ad61550
1 parent bef24e1
commit ad61550
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
@@ -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
+between UTF-16 little-endian and UTF-16 big-endian:
+
+```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