Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save koichik/873202 to your computer and use it in GitHub Desktop.
Save koichik/873202 to your computer and use it in GitHub Desktop.
Document 'ucs2' encoding for Buffer
From 4212f5c89ca3204c52058b46daa0fa9aa85f1014 Mon Sep 17 00:00:00 2001
From: koichik <koichik@improvement.jp>
Date: Thu, 17 Mar 2011 04:59:55 +0900
Subject: [PATCH] Document 'ucs2' encoding for Buffer
---
doc/api/buffers.markdown | 5 ++++-
1 files changed, 4 insertions(+), 1 deletions(-)
diff --git a/doc/api/buffers.markdown b/doc/api/buffers.markdown
index 9c26b61..d752892 100644
--- a/doc/api/buffers.markdown
+++ b/doc/api/buffers.markdown
@@ -17,7 +17,10 @@ method. Here are the different string encodings;
* `'ascii'` - for 7 bit ASCII data only. This encoding method is very fast, and will
strip the high bit if set.
-* `'utf8'` - Unicode characters. Many web pages and other document formats use UTF-8.
+* `'utf8'` - Multi byte encoded Unicode characters. Many web pages and other document formats use UTF-8.
+
+* `'ucs2'` - 2-bytes, little endian encoded Unicode characters. It can encode
+only BMP(Basic Multilingual Plane, U+0000 - U+FFFF).
* `'base64'` - Base64 string encoding.
--
1.7.1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment