summaryrefslogtreecommitdiff
path: root/std/encoding/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'std/encoding/README.md')
-rw-r--r--std/encoding/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/std/encoding/README.md b/std/encoding/README.md
index 6f0704b04..d96075746 100644
--- a/std/encoding/README.md
+++ b/std/encoding/README.md
@@ -219,3 +219,26 @@ Serializes `object` as a YAML document.
See [`./yaml/example`](./yaml/example) folder and [js-yaml] repository.
[js-yaml]: https://github.com/nodeca/js-yaml
+
+## base32
+
+[RFC4648 base32](https://tools.ietf.org/html/rfc4648#section-6) encoder/decoder
+for Deno
+
+### Basic usage
+
+`encode` encodes a `Uint8Array` to RFC4648 base32 representation, and `decode`
+decodes the given RFC4648 base32 representation to a `Uint8Array`.
+
+```ts
+import { encode, decode } from "https://deno.land/std/encoding/base32.ts";
+
+const b32Repr = "RC2E6GA=";
+
+const binaryData = decode(b32Repr);
+console.log(binaryData);
+// => Uint8Array [ 136, 180, 79, 24 ]
+
+console.log(encode(binaryData));
+// => RC2E6GA=
+```