Skip to content

Add field annotations docs #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add field annotations docs #139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/src/usage/annotations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,26 @@ This would generate the following Kotlin code:
typealias Options = String
```

### Override Type for a Field

You can also use language-specific arguments to tell Typeshare to treat
the a field as a type in a particular output language. For example,
```rust
#[typeshare]
struct MyStruct {
#[typeshare(typescript(type = "0 | 1"))]
oneOrZero: u8,
}
```
would generate the following Typescript code:
```typescript
export interface MyStruct {
oneOrZero: 0 | 1;
}
```
The `type` argument is supported for all output languages, however Typescript
also supports the optional `readonly` argument (e.g. `typescript(readonly, type= "0 | 1")`)
to make the output property readonly.

## The `#[serde]` Attribute

Expand Down