From: Jan Klass <kissaki@posteo.de>
Date: Wed, 28 Jun 2023 09:25:46 +0000 (+0200)
Subject: docs(api): Add api-common info on generating TypeScript bindings (#3330)
X-Git-Url: http://these/git/%7BelementUrl%7D?a=commitdiff_plain;h=0f91759e4d1f7092ae23302ccb6426250a07dab2;p=lemmy.git

docs(api): Add api-common info on generating TypeScript bindings (#3330)
---

diff --git a/crates/api_common/README.md b/crates/api_common/README.md
index bf916bf0..f6a16c53 100644
--- a/crates/api_common/README.md
+++ b/crates/api_common/README.md
@@ -24,3 +24,10 @@ As you can see, each API endpoint needs a parameter type ( GetPosts), path (/pos
 For a real example of a Lemmy API client, look at [lemmyBB](https://github.com/LemmyNet/lemmyBB/tree/main/src/api).
 
 Lemmy also provides a websocket API. You can find the full websocket code in [this file](https://github.com/LemmyNet/lemmy/blob/main/src/api_routes_websocket.rs).
+
+## Generate TypeScript bindings
+
+TypeScript bindings (API types) can be generated by running `cargo test --features full`.
+The ts files be generated into a `bindings` folder.
+
+This crate uses [`ts_rs`](https://docs.rs/ts-rs/6.2.1/ts_rs/#traits) macros `derive(TS)` and `ts(export)` to attribute types for binding generating.