ts-rs 12.0.1

generate typescript bindings from rust types
Documentation 
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

#![allow(dead_code)]

use std::collections::{BTreeMap, HashMap, HashSet};

use ts_rs::{Config, TS};

#[derive(TS)]
#[ts(export, export_to = "hashmap/")]
struct Hashes {
    map: HashMap<String, String>,
    set: HashSet<String>,
}

#[test]
fn hashmap() {
    let cfg = Config::from_env();
    assert_eq!(
        Hashes::decl(&cfg),
        "type Hashes = { map: { [key in string]: string }, set: Array<string>, };"
    )
}

struct CustomHasher {}

type CustomHashMap<K, V> = HashMap<K, V, CustomHasher>;
type CustomHashSet<K> = HashSet<K, CustomHasher>;

#[derive(TS)]
#[ts(export, export_to = "hashmap/")]
struct HashesHasher {
    map: CustomHashMap<String, String>,
    set: CustomHashSet<String>,
}

#[test]
fn hashmap_with_custom_hasher() {
    let cfg = Config::from_env();
    assert_eq!(
        HashesHasher::decl(&cfg),
        "type HashesHasher = { map: { [key in string]: string }, set: Array<string>, };"
    )
}

#[derive(TS, Eq, PartialEq, Hash)]
#[ts(export, export_to = "hashmap/")]
struct CustomKey(String);

#[derive(TS)]
#[ts(export, export_to = "hashmap/")]
struct CustomValue;

#[derive(TS)]
#[ts(export, export_to = "hashmap/")]
struct HashMapWithCustomTypes {
    map: HashMap<CustomKey, CustomValue>,
}

#[derive(TS)]
#[ts(export, export_to = "hashmap/")]
struct BTreeMapWithCustomTypes {
    map: BTreeMap<CustomKey, CustomValue>,
}

#[derive(TS)]
#[ts(export, export_to = "hashmap/")]
enum EnumKey {
    Foo,
    Bar,
}

#[test]
fn with_custom_types() {
    let cfg = Config::from_env();
    assert_eq!(
        HashMapWithCustomTypes::inline(&cfg),
        BTreeMapWithCustomTypes::inline(&cfg)
    );
    assert_eq!(
        HashMapWithCustomTypes::decl(&cfg),
        "type HashMapWithCustomTypes = { map: { [key in CustomKey]: CustomValue }, };"
    );
    assert_eq!(
        HashMap::<EnumKey, String>::name(&cfg),
        "{ [key in EnumKey]?: string }"
    );
    assert_eq!(
        HashMap::<EnumKey, String>::inline(&cfg),
        r#"{ [key in "Foo" | "Bar"]?: string }"#
    );
}