From 5ccdff48f3c9cbc16c10ef05b1519a6756cd8e29 Mon Sep 17 00:00:00 2001 From: koichik Date: Thu, 17 Mar 2011 04:59:55 +0900 Subject: [PATCH] Document 'ucs2' encoding for Buffer --- doc/api/buffers.markdown | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/api/buffers.markdown b/doc/api/buffers.markdown index 9c26b61a12..d752892405 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.