#serde #struct #typescript #definition #wasm-bindgen #definitions #support

macro wasm-typescript-definition

serde support for exporting Typescript definitions using wasm-bindgen

1 unstable release

0.1.0 Nov 21, 2018
Download history 4/week @ 2018-11-21

1 downloads per month

MIT/Apache

25KB
271 lines

wasm-typescript-definition

Exports serde-serializable structs and enums to Typescript definitions when used with wasm-bindgen.

#[derive(Serialize, TypescriptDefinition)]
enum Enum {
    #[allow(unused)]
    V1 {
        #[serde(rename = "Foo")]
        foo: bool,
    },
    #[allow(unused)]
    V2 {
        #[serde(rename = "Bar")]
        bar: i64,
        #[serde(rename = "Baz")]
        baz: u64,
    },
    #[allow(unused)]
    V3 {
        #[serde(rename = "Quux")]
        quux: String,
    },
}

With the patched version of wasm-bindgen that supports typescript_custom_section (TODO), this will output in your .d.ts definition file:

export type Enum = 
    | {"tag": "V1", "fields": { "Foo": boolean, }, }
    | {"tag": "V2", "fields": { "Bar": number, "Baz": number, }, }
    | {"tag": "V3", "fields": { "Quux": string, }, }
    ;

Credit

Forked from rust-serde-schema by @srijs.

License

MIT or Apache-2.0, at your option.

Dependencies

~1.5MB
~28K SLoC