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

Jump to bottom

docs: Meta type in documentation is wrong #3453

Closed
1 task done
iduuck opened this issue Dec 22, 2022 · 0 comments · Fixed by #3459 or #3462
Closed
1 task done

docs: Meta type in documentation is wrong #3453

iduuck opened this issue Dec 22, 2022 · 0 comments · Fixed by #3459 or #3462
Labels
📚 documentation / examples Improvements or additions to documentation

Comments

@iduuck
Copy link
Contributor

iduuck commented Dec 22, 2022 •
edited

Area of Improvement

In the documentation, it is suggested to use an interface for the Meta typing. This is wrong and does not work (and in my case confuses the developer massively, since it is telling, that it is not complying to Record<string, unknown>).

Read more about this: microsoft/TypeScript#15300 (comment)

We need to switch this to a type in the documentation.

Link to related docs

https://trpc.io/docs/metadata

Additional information

https://stackblitz.com/edit/github-n9oaj1?file=src/server/trpc.ts

👨‍👧‍👦 Contributing

  • 🙋‍♂️ Yes, I'd be down to file a PR implementing the suggested changes!
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
📚 documentation / examples Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
1 participant
@iduuck