ts-typegen 1.0.0

Generate TypeScript types and interfaces from Rust structs and enums at build time, matching what serde puts on the wire
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

//! Marker derive for types that should have TypeScript bindings generated.
//!
//! Generation itself happens in a build script via the `ts-typegen-build` crate.
//! This derive expands to nothing; it exists so that `#[ts(...)]` is legal syntax
//! and so the build-time scanner has a marker to look for.
//!
//! Pair it with `#[derive(Serialize)]`, since bindings describe the JSON
//! serde actually writes:
//!
//! ```
//! use serde::Serialize;
//! use ts_typegen::Ts;
//!
//! #[derive(Serialize, Ts)]
//! #[serde(rename_all = "camelCase")]
//! struct User {
//!     user_id: u64,
//!     name: String,
//!     #[serde(skip)]
//!     secret: String,
//! }
//! ```
//!
//! `#[ts(...)]` is the escape hatch for anything serde's shape doesn't
//! capture on its own — see the crate README for the full attribute list.
#![forbid(unsafe_code)]

pub use ts_typegen_macros::Ts;

#[cfg(feature = "strict")]
mod marker;
#[cfg(feature = "strict")]
pub use marker::TsType;