generate typescript interface/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 = "7.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 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
- generic fields cannot be inlined or flattened (#56)
- type aliases must not alias generic types (#70)
-
serde-compat
(default)Enable serde compatibility. See below for more info.
-
format
When enabled, the generated typescript will be formatted. Currently, this sadly adds quite a bit of dependencies.
-
chrono-impl
Implement
TS
for types from chrono -
bigdecimal-impl
Implement
TS
for types from bigdecimal -
url-impl
Implement
TS
for types from url -
uuid-impl
Implement
TS
for types from uuid -
bson-uuid-impl
Implement
TS
for types from bson -
bytes-impl
Implement
TS
for types from bytes -
indexmap-impl
Implement
TS
forIndexMap
andIndexSet
from indexmap -
ordered-float-impl
Implement
TS
forOrderedFloat
from ordered_float -
heapless-impl
Implement
TS
forVec
from heapless
If there's a type you're dealing with which doesn't implement TS
, use #[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
tag
content
untagged
skip
skip_serializing
skip_deserializing
skip_serializing_if = "Option::is_none"
flatten
default
When ts-rs encounters an unsupported serde attribute, a warning is emitted.
Contributions are always welcome! Feel free to open an issue, discuss using GitHub discussions or open a PR. See CONTRIBUTING.md
- serde compatibility layer
- documentation
- use typescript types across files
- more enum representations
- generics
- don't require
'static
License: MIT
ts-rs's People
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.