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.

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

Unclear instruction on how to use Typia #1017

Open
tnhh00037 opened this issue Mar 29, 2024 · 1 comment
Open

Unclear instruction on how to use Typia #1017

tnhh00037 opened this issue Mar 29, 2024 · 1 comment

Comments

@tnhh00037
Copy link

I'm interested in Typia. However I am struggling finding how to use Typia via its official document. I can list a few

  1. No clear instruction on how to compile typescript to javascript
    Tried to look for way to do this, but I couldn't find any related information.
    Eventually I tried to build typescript by npx tsc as I normally do and it worked
    I think it's better to mention this information somewhere in the document

  2. No mention about whether need to build everything to javascript before running it, or can run directly typescript file with popular libraries like ts-node or ts-node-dev

  3. No instruction on how to build .proto file
    I saw document mentioned about protobuf support. And again, no clear mention about whether Typia can help user generate .proto file or not. And if yes, how to do it.

I suggest adding step-to-step instruction (including commands) to use each feature.
Also it would be great if there is sample repository to let user clone and try using Typo

Thank you for you hardwork!

@samchon
Copy link
Owner

samchon commented Mar 29, 2024

Hope your contribution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants