Merge pull request #1986 from clearloop/master

Add typescript_type attribute

Author: Pauan

crates/typescript-tests/src/lib.rs

@@ -5,4 +5,5 @@ pub mod opt_args_and_ret;
 pub mod optional_fields;
 pub mod simple_fn;
 pub mod simple_struct;
+pub mod typescript_type;
 pub mod web_sys;

crates/typescript-tests/src/typescript_type.rs

@@ -0,0 +1,38 @@
+use wasm_bindgen::prelude::*;
+
+#[wasm_bindgen(typescript_custom_section)]
+const ITEXT_STYLE: &'static str = r#"
+interface ITextStyle {
+    bold: boolean;
+    italic: boolean;
+    size: number;
+}
+"#;
+
+#[wasm_bindgen]
+extern "C" {
+    #[wasm_bindgen(typescript_type = "ITextStyle")]
+    pub type ITextStyle;
+}
+
+#[wasm_bindgen]
+#[derive(Default)]
+pub struct TextStyle {
+    pub bold: bool,
+    pub italic: bool,
+    pub size: i32,
+}
+
+#[wasm_bindgen]
+impl TextStyle {
+    #[wasm_bindgen(constructor)]
+    pub fn new(_i: ITextStyle) -> TextStyle {
+        // parse JsValue
+        TextStyle::default()
+    }
+
+    pub fn optional_new(_i: Option<ITextStyle>) -> TextStyle {
+        // parse JsValue
+        TextStyle::default()
+    }
+}

crates/typescript-tests/src/typescript_type.ts

@@ -0,0 +1,9 @@
+import * as wbg from '../pkg/typescript_tests';
+
+const style: wbg.TextStyle = new wbg.TextStyle({
+  bold: true,
+  italic: true,
+  size: 42,
+});
+
+const optional_style: wbg.TextStyle = wbg.TextStyle.optional_new();

guide/src/SUMMARY.md

@@ -82,6 +82,7 @@
       - [`getter` and `setter`](./reference/attributes/on-rust-exports/getter-and-setter.md)
       - [`inspectable`](./reference/attributes/on-rust-exports/inspectable.md)
       - [`skip_typescript`](./reference/attributes/on-rust-exports/skip_typescript.md)
+      - [`typescript_type`](./reference/attributes/on-rust-exports/typescript_type.md)
 
 - [`web-sys`](./web-sys/index.md)
   - [Using `web-sys`](./web-sys/using-web-sys.md)

guide/src/reference/attributes/on-rust-exports/typescript_type.md

@@ -0,0 +1,56 @@
+# typescript_type
+
+The `typescript_type` allows us to use typescript declarations in `typescript_custom_section` as arguments for rust functions! For example:
+
+```rust
+#[wasm_bindgen(typescript_custom_section)]
+const ITEXT_STYLE: &'static str = r#"
+interface ITextStyle {
+    bold: boolean;
+    italic: boolean;
+    size: number;
+}
+"#;
+
+#[wasm_bindgen]
+extern "C" {
+    #[wasm_bindgen(typescript_type = "ITextStyle")]
+    pub type ITextStyle;
+}
+
+#[wasm_bindgen]
+#[derive(Default)]
+pub struct TextStyle {
+    pub bold: bool,
+    pub italic: bool,
+    pub size: i32,
+}
+
+#[wasm_bindgen]
+impl TextStyle {
+    #[wasm_bindgen(constructor)]
+    pub fn new(_i: ITextStyle) -> TextStyle {
+        // parse JsValue
+        TextStyle::default()
+    }
+
+    pub fn optional_new(_i: Option<ITextStyle>) -> TextStyle {
+        // parse JsValueo
+        TextStyle::default()
+    }
+}
+```
+
+We can write our `typescript` code like: 
+
+```ts
+import { ITextStyle, TextStyle } from "./my_awesome_module";
+
+const style: TextStyle = new TextStyle({
+  bold: true,
+  italic: true,
+  size: 42,
+});
+
+const optional_style: TextStyle = TextStyle.optional_new();
+```