typewriter-typescript 0.3.0

TypeScript emitter for the typewriter type sync SDK
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
34
35
36

# typewriter-typescript

> TypeScript emitter for the [typewriter](https://github.com/aarambh-darshan/typewriter) SDK.

[![Crates.io](https://img.shields.io/crates/v/typewriter-typescript.svg)](https://crates.io/crates/typewriter-typescript)
[![Docs.rs](https://docs.rs/typewriter-typescript/badge.svg)](https://docs.rs/typewriter-typescript)

## What It Generates

| Rust | TypeScript |
|---|---|
| `struct` | `export interface` |
| Simple `enum` | String literal union (`"A" \| "B"`) |
| Tagged `enum` | Discriminated union (`{ type: "A"; ... }`) |
| `Option<T>` | `field?: T \| undefined` |
| `Vec<T>` | `T[]` |
| `HashMap<K,V>` | `Record<K, V>` |

## Example Output

```typescript
export interface UserProfile {
  id: string;
  email: string;
  age?: number | undefined;
  tags: string[];
}
```

## Usage

Used internally by `typewriter-macros`. Most users should depend on the main [`typewriter`](https://crates.io/crates/typewriter) crate.

## License

Apache-2.0 — [Darshan Vichhi](https://github.com/aarambh-darshan)