diff options
| author | James M Snell <jasnell@gmail.com> | 2018-10-18 18:22:46 -0700 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2018-10-19 10:51:12 -0700 |
| commit | ad61550646f6ec5204ece41aab08cca18eef7dbb (patch) | |
| tree | db76c9143542504d871c595092490fe63193d5f3 /doc | |
| parent | bef24e163a1a7e66bd1b2daa43ecfc8924034a7f (diff) | |
| download | android-node-v8-ad61550646f6ec5204ece41aab08cca18eef7dbb.tar.gz android-node-v8-ad61550646f6ec5204ece41aab08cca18eef7dbb.tar.bz2 android-node-v8-ad61550646f6ec5204ece41aab08cca18eef7dbb.zip | |
doc: document use of buffer.swap16() for utf16be
Fixes: https://github.com/nodejs/node/issues/12813
PR-URL: https://github.com/nodejs/node/pull/23747
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/buffer.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 11f3795741..c62e3380e9 100644 --- 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 |