1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101 |
x15
x15
x15
x15
x15
x15
x15 |
|
// Copyright 2018-2025 the Deno authors. MIT license.
// This module is browser compatible.
/**
* Utilities for encoding and decoding common formats like hex, base64, and varint.
*
* ## Basic Usage
*
* ```ts
* import { encodeBase64, decodeBase64 } from "@std/encoding";
* import { assertEquals } from "@std/assert";
*
* const foobar = new TextEncoder().encode("foobar");
* assertEquals(encodeBase64(foobar), "Zm9vYmFy");
* assertEquals(decodeBase64("Zm9vYmFy"), foobar);
* ```
*
* ## Various Encoding Formats
*
* ```ts
* import {
* encodeHex,
* encodeBase32,
* encodeBase58,
* encodeBase64,
* encodeAscii85,
* decodeHex,
* decodeBase32,
* decodeBase58,
* decodeBase64,
* decodeAscii85,
* } from "@std/encoding";
* import { assertEquals } from "@std/assert";
*
* // Many different encodings for different character sets
* assertEquals(encodeHex("Hello world!"), "48656c6c6f20776f726c6421");
* assertEquals(encodeBase32("Hello world!"), "JBSWY3DPEB3W64TMMQQQ====");
* assertEquals(encodeBase58("Hello world!"), "2NEpo7TZRhna7vSvL");
* assertEquals(encodeBase64("Hello world!"), "SGVsbG8gd29ybGQh");
* assertEquals(encodeAscii85("Hello world!"), "87cURD]j7BEbo80");
*
* // Decoding
* assertEquals(new TextDecoder().decode(decodeHex("48656c6c6f20776f726c6421")), "Hello world!");
* assertEquals(new TextDecoder().decode(decodeBase32("JBSWY3DPEB3W64TMMQQQ====")), "Hello world!");
* assertEquals(new TextDecoder().decode(decodeBase58("2NEpo7TZRhna7vSvL")), "Hello world!");
* assertEquals(new TextDecoder().decode(decodeBase64("SGVsbG8gd29ybGQh")), "Hello world!");
* assertEquals(new TextDecoder().decode(decodeAscii85("87cURD]j7BEbo80")), "Hello world!");
* ```
*
* ## URL-Safe Base64
*
* ```ts
* import { encodeBase64, encodeBase64Url } from "@std/encoding";
* import { assertEquals } from "@std/assert";
*
* assertEquals(encodeBase64("ice creams"), "aWNlIGNyZWFtcw=="); // Not url-safe because of `=`
* assertEquals(encodeBase64Url("ice creams"), "aWNlIGNyZWFtcw"); // URL-safe!
*
* // Base64Url replaces + with - and / with _
* assertEquals(encodeBase64("subjects?"), "c3ViamVjdHM/"); // slash is not URL-safe
* assertEquals(encodeBase64Url("subjects?"), "c3ViamVjdHM_"); // _ is URL-safe
* ```
*
* ## Binary Data Encoding
*
* ```ts
* import { encodeHex, encodeBase64 } from "@std/encoding";
* import { assertEquals } from "@std/assert";
*
* // Working with binary data
* const binaryData = new Uint8Array([0xDE, 0xAD, 0xBE, 0xEF]);
* assertEquals(encodeHex(binaryData), "deadbeef");
* assertEquals(encodeBase64(binaryData), "3q2+7w==");
* ```
*
* ## Varint Encoding
*
* Learn more from the [protobuf Varint encoding docs](https://protobuf.dev/programming-guides/encoding/#varints).
*
* ```ts
* import { encodeVarint, decodeVarint } from "@std/encoding";
* import { assertEquals } from "@std/assert";
*
* // Varint encoding support
* assertEquals(encodeVarint(9601n), [new Uint8Array([129, 75]), 2]);
*
* // Decode a varint
* const bytes = new Uint8Array([129, 75]);
* assertEquals(decodeVarint(bytes), [9601n, 2]);
* ```
*
* @module
*/
export * from "./ascii85.ts";
export * from "./base32.ts";
export * from "./base58.ts";
export * from "./base64.ts";
export * from "./base64url.ts";
export * from "./hex.ts";
export * from "./varint.ts";
|