Crate gents 

gents

gents is a tool for generating Typescript files. You can easily use serde-json to establish the communication between Rust and Typescript. It is useful when you are developing a web service or a wasm project.

Step1: Derive TS and set the file_name.

use gents_derives::TS;

#[derive(TS)]
#[ts(file_name = "person.ts")]
pub struct Person {
    pub age: u16,
}

Step2: Set your rename policy.

Currently, you can set camelCase using rename_all, or you can rename each field by using rename.

use gents_derives::TS;

#[derive(TS)]
#[ts(file_name = "person.ts", rename_all = "camelCase")]
pub struct Person {
    pub age: u16,
    #[ts(rename="name")]
    pub en_name: String,
}

Step3: Register your root structs or enums.

We recommend that you can write a unit test to do it. You can also write a binary for it but please run the binary with --cfg=test. The proc macro TS will generate the code under #[cfg(test)], which means these code can be run only in test environment and they will never influence your code.

use gents::FileGroup;
use gents_derives::TS;
#[derive(TS)]
#[ts(file_name = "person.ts")]
pub struct Person{}

#[ignore]
#[test]
fn generate_ts_files() {
    let mut g = FileGroup::new();
    g.add::<Person>();
    g.gen_files("outdir", false); // false for not generating index.ts
}

.add adds the target and its dependencies into the FileGroup and their files will be generated in the same time.

Step4: Run the unit test

Re-exports

pub use serde;

pub use serde_with;

Structs

ApiDescriptor

BuiltinTypeDescriptor

DescriptorManager

EnumDescriptor

FieldDescriptor

FileGroup

Members from a FileGroup will:

GenericDescriptor

InterfaceDescriptor

Describe how to generate a ts interface.

MethodDescriptor

Enums

Descriptor

Traits

TS

_TsAPI

Trait for defining TypeScript API interfaces This should not be used directly - it’s intended for internal use by the gents framework. Use the #[gents_derives::ts_interface] attribute macro to define TypeScript interfaces.