Skip to content
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

docs(README): Mention another usage of typelize #18

Merged
merged 1 commit into from
Nov 6, 2024
Merged

docs(README): Mention another usage of typelize #18

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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,20 @@ class PostResource < ApplicationResource
end
```

`typelize` can be used with a Hash to specify multiple types at once.

```ruby
class PostResource < ApplicationResource
attributes :id, :title, :body, :published_at

attribute :author_name do |post|
post.author.name
end

typelize author_name: :string, published_at: :string
end
```

### TypeScript Integration

Typelizer generates TypeScript interfaces in the specified output directory:
Expand Down
Loading