We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 24b2e7e commit be9653bCopy full SHA for be9653b
src/gbase32_clockwork/gbase32.gleam
@@ -22,6 +22,14 @@ pub type DecodeFn =
22
23
/// Create a new encoder that can be be reused to encode strings in base32 clockwork
24
///
25
+/// ## Examples
26
+///
27
+/// ```gleam
28
+/// let encode = new_encoder()
29
+/// encode("foobar")
30
+/// // -> Ok("csqpyrk1e8")
31
+/// ```
32
33
pub fn new_encoder() -> EncodeFn {
34
let encodebook: EncodeBook =
35
clockwork_codebook
@@ -34,6 +42,14 @@ pub fn new_encoder() -> EncodeFn {
42
43
/// Create a new decoder that can be be reused to decode strings from base32 clockwork
36
44
45
46
47
48
+/// let decode = new_decoder()
49
+/// decode("CSQPYRK1E8")
50
+/// // -> Ok("foobar")
51
52
37
53
pub fn new_decoder() -> DecodeFn {
38
54
let decodebook: DecodeBook =
39
55
0 commit comments