Commit 1411e0b
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: #5243
Reviewed-By: Ben Noorhduis <info@bnoordhuis.nl>
Reviewed-By: Benjamin Gruenbaum <inglor@gmail.com>
Reviewed-By: Alejandro Oviedo <alejandro.oviedo.g@gmail.com>1 parent c6ae7d0 commit 1411e0b
1 file changed
Lines changed: 4 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -62,7 +62,9 @@ The character encodings currently supported by Node.js include: | |||
| 62 | 62 | ||
| 63 | 63 | * `'ucs2'` - Alias of `'utf16le'`. | |
| 64 | 64 | ||
| 65 | - * `'base64'` - Base64 string encoding. | ||
| 65 | + * `'base64'` - Base64 string encoding. When creating a buffer from a string, | ||
| 66 | + this encoding will also correctly accept "URL and Filename Safe Alphabet" as | ||
| 67 | + specified in [RFC 4648, Section 5]. | ||
| 66 | 68 | ||
| 67 | 69 | * `'binary'` - A way of encoding the buffer into a one-byte (`latin-1`) | |
| 68 | 70 | encoded string. The string `'latin-1'` is not supported. Instead, pass | |
@@ -1379,3 +1381,4 @@ has observed undue memory retention in their applications. | |||
| 1379 | 1381 | [`String.prototype.length`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length | |
| 1380 | 1382 | [`util.inspect()`]: util.html#util_util_inspect_object_options | |
| 1381 | 1383 | [iterator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | |
| 1384 | + [RFC 4648, Section 5]: https://tools.ietf.org/html/rfc4648#section-5 | ||
0 commit comments