Generate typescript type declarations from rust types

When building a web application in rust, data structures have to be shared between backend and frontend. Using this library, you can easily generate TypeScript bindings to your rust structs & enums so that you can keep your types in one place.

ts-rs might also come in handy when working with webassembly.

ts-rs exposes a single trait, TS. Using a derive macro, you can implement this interface for your types. Then, you can use this trait to obtain the TypeScript bindings. We recommend doing this in your tests. See the example and the docs.

[dependencies]
ts-rs = "9.0"

use ts_rs::TS;

#[derive(TS)]
#[ts(export)]
struct User {
    user_id: i32,
    first_name: String,
    last_name: String,
}

When running cargo test, the TypeScript bindings will be exported to the file bindings/User.ts.

• generate type declarations from rust structs
• generate union declarations from rust enums
• inline types
• flatten structs/types
• generate necessary imports when exporting to multiple files
• serde compatibility
• generic types
• support for ESM imports

If there's a type you're dealing with which doesn't implement TS, use either #[ts(as = "..")] or #[ts(type = "..")], or open a PR.

With the serde-compat feature (enabled by default), serde attributes can be parsed for enums and structs. Supported serde attributes:

• rename
• rename-all
• rename-all-fields
• tag
• content
• untagged
• skip
• flatten
• default

Note: skip_serializing and skip_deserializing are ignored. If you wish to exclude a field from the generated type, but cannot use #[serde(skip)], use #[ts(skip)] instead.

When ts-rs encounters an unsupported serde attribute, a warning is emitted, unless the feature no-serde-warnings is enabled.

Contributions are always welcome! Feel free to open an issue, discuss using GitHub discussions or open a PR. See CONTRIBUTING.md

The Minimum Supported Rust Version for this crate is 1.63.0

License: MIT