ts-rs
ts-rs
generate typescript interface/type declarations from rust types
why?
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.
how?
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.
get started
[dependencies] ts-rs = "7.1"
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.
features
- generate interface declarations from rust structs
- generate union declarations from rust enums
- inline types
- flatten structs/interfaces
- generate necessary imports when exporting to multiple files
- serde compatibility
- generic types
- support for ESM imports
limitations
- generic fields cannot be inlined or flattened (#56)
- type aliases must not alias generic types (#70)
cargo features
-
serde-compat(default)Enable serde compatibility. See below for more info.
-
formatWhen enabled, the generated typescript will be formatted. Currently, this sadly adds quite a bit of dependencies.
-
chrono-implImplement
TSfor types from chrono -
bigdecimal-implImplement
TSfor types from bigdecimal -
url-implImplement
TSfor types from url -
uuid-implImplement
TSfor types from uuid -
bson-uuid-implImplement
TSfor types from bson -
bytes-implImplement
TSfor types from bytes -
indexmap-implImplement
TSforIndexMapandIndexSetfrom indexmap -
ordered-float-implImplement
TSforOrderedFloatfrom ordered_float -
heapless-implImplement
TSforVecfrom heapless -
no-serde-warningsWhen
serde-compatis enabled, warnings are printed during build if unsupported serde attributes are encountered. Enabling this feature silences these warnings. -
import-esmimportstatements in the generated file will have the.jsextension in the end of the path to conform to the ES Modules spec. (e.g.:import { MyStruct } from "./my_struct.js")
If there's a type you're dealing with which doesn't implement TS, use #[ts(type = "..")] or open a PR.
serde compatability
With the serde-compat feature (enabled by default), serde attributes can be parsed for enums and structs.
Supported serde attributes:
renamerename-alltagcontentuntaggedskipskip_serializingskip_deserializingskip_serializing_if = "Option::is_none"flattendefault
When ts-rs encounters an unsupported serde attribute, a warning is emitted, unless the feature no-serde-warnings is enabled.
contributing
Contributions are always welcome! Feel free to open an issue, discuss using GitHub discussions or open a PR. See CONTRIBUTING.md
todo
- serde compatibility layer
- documentation
- use typescript types across files
- more enum representations
- generics
-
don't require
'static
License: MIT