Add section on JavaScript interop for custom types

For gleam-lang#200.
nino · Sep 9, 2023 · 9438f50 · 9438f50
1 parent 0044577
commit 9438f50
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/book-src/tour/custom-types.md b/book-src/tour/custom-types.md
@@ -250,3 +250,23 @@ LoggedIn("Kim")
 guest,
 {logged_in, <<"Kim">>}.
 ```
+
+## JavaScript interop
+
+When compiling to JavaScript, each constructor becomes a class of the same name.
+Each of the generated JavaScript classes has a constructor with the same
+arguments as the original type constructor.
+
+```gleam
+// Gleam
+Guest
+LoggedIn("Kim")
+Cat(name: "Jinx", cuteness: 2002)
+```
+
+```javascript
+// JavaScript
+new Guest();              // => {}
+new LoggedIn("Kim");      // => { 0: "Kim" }
+new Animal("Jinx", 2002); // => { name: "Jinx", cuteness: 2002 }
+```