@@ -31,51 +31,52 @@ pub fn classify(data: Dynamic) -> String
31
31
@ external ( javascript , "../gleam_stdlib.mjs" , "identity" )
32
32
pub fn from ( a : anything) -> Dynamic
33
33
34
- // TODO: document
34
+ /// Create a dynamic value from a bool.
35
35
@ external ( erlang , "gleam_stdlib" , "identity" )
36
36
@ external ( javascript , "../gleam_stdlib.mjs" , "identity" )
37
37
pub fn bool ( a : Bool ) -> Dynamic
38
38
39
- // TODO: document
39
+ /// Create a dynamic value from a string.
40
40
@ external ( erlang , "gleam_stdlib" , "identity" )
41
41
@ external ( javascript , "../gleam_stdlib.mjs" , "identity" )
42
42
pub fn string ( a : String ) -> Dynamic
43
43
44
- // TODO: document
45
- // TODO: test
44
+ /// Create a dynamic value from a float.
46
45
@ external ( erlang , "gleam_stdlib" , "identity" )
47
46
@ external ( javascript , "../gleam_stdlib.mjs" , "identity" )
48
47
pub fn float ( a : Float ) -> Dynamic
49
48
50
- // TODO: document
49
+ /// Create a dynamic value from an int.
51
50
@ external ( erlang , "gleam_stdlib" , "identity" )
52
51
@ external ( javascript , "../gleam_stdlib.mjs" , "identity" )
53
52
pub fn int ( a : Int ) -> Dynamic
54
53
55
- // TODO: document
56
- // TODO: test
54
+ /// Create a dynamic value from a bit array.
57
55
@ external ( erlang , "gleam_stdlib" , "identity" )
58
56
@ external ( javascript , "../gleam_stdlib.mjs" , "identity" )
59
57
pub fn bit_array ( a : BitArray ) -> Dynamic
60
58
61
- // TODO: document
62
- // TODO: test
59
+ /// Create a dynamic value from a list.
63
60
@ external ( erlang , "gleam_stdlib" , "identity" )
64
61
@ external ( javascript , "../gleam_stdlib.mjs" , "identity" )
65
62
pub fn list ( a : List ( Dynamic ) ) -> Dynamic
66
63
67
- // TODO: document
68
- // TODO: test
64
+ /// Create a dynamic value from a list, converting it to a sequential runtime
65
+ /// format rather than the regular list format.
66
+ ///
67
+ /// On Erlang this will be a tuple, on JavaScript this wil be an array.
68
+ ///
69
69
@ external ( erlang , "erlang" , "list_to_tuple" )
70
70
@ external ( javascript , "../gleam_stdlib.mjs" , "list_to_array" )
71
71
pub fn array ( a : List ( Dynamic ) ) -> Dynamic
72
72
73
- // TODO: document
73
+ /// Create a dynamic value made an unordered series of keys and values, where
74
+ /// the keys are unique.
74
75
pub fn object ( entries : List ( # ( Dynamic , Dynamic ) ) ) -> Dynamic {
75
76
cast ( dict . from_list ( entries ) )
76
77
}
77
78
78
- // TODO: document
79
+ /// A dynamic value representing nothing.
79
80
pub fn null ( ) -> Dynamic {
80
81
cast ( Nil )
81
82
}
0 commit comments