Trait ts_rs::TS [−][src]
pub trait TS: 'static {
fn name() -> String;
fn dependencies() -> Vec<(TypeId, String)>;
fn transparent() -> bool;
fn decl() -> String { ... }
fn inline(indent: usize) -> String { ... }
fn inline_flattened(indent: usize) -> String { ... }
fn dump(out: impl AsRef<Path>) -> Result<()> { ... }
}Expand description
A type which can be represented in TypeScript.
Most of the time, you’d want to derive this trait instead of implementing it manually.
ts-rs comes with implementations for all numeric types, String, Vec, Option and tuples.
get started
TS can easily be derived for structs and enums:
use ts_rs::TS;
#[derive(TS)]
struct User {
first_name: String,
last_name: String,
}To actually obtain the bindings, you can call User::dump to write the bindings to a file.
std::fs::remove_file("bindings.ts").ok();
User::dump("bindings.ts").unwrap();Preferrably, you should use the export! macro, which takes care of dependencies
between types and allows you to decide between export and declare.
struct attributes
-
#[ts(rename = "..")]:
Set the name of the generated interface -
#[ts(rename_all = "..")]:
Rename all fields of this struct.
Valid values arelowercase,UPPERCASE,camelCase,snake_case,PascalCase,SCREAMING_SNAKE_CASE
struct field attributes
-
#[ts(type = "..")]:
Overrides the type used in TypeScript -
#[ts(rename = "..")]:
Renames this field -
#[ts(inline)]:
Inlines the type of this field -
#[ts(skip)]:
Skip this field -
`#[ts(optional)] Indicates the field may be omitted from the serialized struct
-
#[ts(flatten)]:
Flatten this field (only works if the field is a struct)
enum attributes
-
#[ts(rename = "..")]:
Set the name of the generated type -
#[ts(rename_all = "..")]:
Rename all variants of this enum.
Valid values arelowercase,UPPERCASE,camelCase,snake_case,PascalCase,SCREAMING_SNAKE_CASE
enum variant attributes
-
#[ts(rename = "..")]:
Renames this variant -
#[ts(skip)]:
Skip this variant
Required methods
All type ids and typescript names of the types this type depends on.
This is used for resolving imports when using the export! macro.
fn transparent() -> bool
fn transparent() -> bool
true if this is a transparent type, e.g tuples or a list.
This is used for resolving imports when using the export! macro.
Provided methods
Declaration of this type, e.g. interface User { user_id: number, ... }.
This function will panic if the type has no declaration.
Formats this types definition in TypeScript, e.g { user_id: number }.
This function will panic if the type cannot be inlined.
fn inline_flattened(indent: usize) -> String
fn inline_flattened(indent: usize) -> String
Flatten an type declaration.
This function will panic if the type cannot be flattened.