From 1624d5b0499233cacb4b42e91deddb767d6e4c3d Mon Sep 17 00:00:00 2001 From: Tristan Slominski Date: Mon, 15 Feb 2016 11:44:53 -0600 Subject: [PATCH] doc: document base64url encoding support Documents that creating a buffer from base64 encoded string transparently supports "URL and Filename Safe Alphabet" base64url encoding. PR-URL: https://github.com/nodejs/node/pull/5243 Reviewed-By: Ben Noorhduis Reviewed-By: Benjamin Gruenbaum Reviewed-By: Alejandro Oviedo --- doc/api/buffer.markdown | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/api/buffer.markdown b/doc/api/buffer.markdown index ac8b564..c28683d 100644 --- a/doc/api/buffer.markdown +++ b/doc/api/buffer.markdown @@ -62,7 +62,9 @@ The character encodings currently supported by Node.js include: * `'ucs2'` - Alias of `'utf16le'`. -* `'base64'` - Base64 string encoding. +* `'base64'` - Base64 string encoding. When creating a buffer from a string, + this encoding will also correctly accept "URL and Filename Safe Alphabet" as + specified in [RFC 4648, Section 5]. * `'binary'` - A way of encoding the buffer into a one-byte (`latin-1`) encoded string. The string `'latin-1'` is not supported. Instead, pass @@ -1364,3 +1366,4 @@ has observed undue memory retention in their applications. [`String.prototype.length`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length [`util.inspect()`]: util.html#util_util_inspect_object_options [iterator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols +[RFC 4648, Section 5]: https://tools.ietf.org/html/rfc4648#section-5 -- 2.7.4