From 57f99a947990ba15956c3f2beeaf35fe0e81b7a4 Mon Sep 17 00:00:00 2001 From: Trevor Norris Date: Mon, 19 Oct 2015 14:06:51 -0600 Subject: [PATCH] doc: binary encoding is not deprecated When v8 implemented proper one-byte string support Node's internal "binary" encoding implementation was removed in favor of it. The result was that "binary" encoding effectively became "latin-1" encoding. Because of this and because one-byte strings are natively supported by v8 the buffer encoding is not deprecated and will not be removed. Ref: 83261e7 "deps: update v8 to 3.17.13" PR-URL: https://github.com/nodejs/node/pull/3441 Reviewed-By: Ben Noordhuis --- doc/api/buffer.markdown | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/doc/api/buffer.markdown b/doc/api/buffer.markdown index 22faef5563cb06..0f3a2ff2f72c4d 100644 --- a/doc/api/buffer.markdown +++ b/doc/api/buffer.markdown @@ -30,10 +30,9 @@ encoding method. Here are the different string encodings. * `'base64'` - Base64 string encoding. -* `'binary'` - A way of encoding raw binary data into strings by using only - the first 8 bits of each character. This encoding method is deprecated and - should be avoided in favor of `Buffer` objects where possible. This encoding - will be removed in future versions of Node.js. +* `'binary'` - A way of encoding the buffer into a one-byte (i.e. `latin-1`) + encoded string. The string `'latin-1'` is not supported. Instead simply pass + `'binary'` to use `'latin-1'` encoding. * `'hex'` - Encode each byte as two hexadecimal characters.