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
docs: correct use of individual package in node env #682
Conversation
@dhruvdutt can you review please? |
4242545
to
2ad1eb5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lgtm, could you sign the CLA?
@evenstensberg Yes, I did after I got the notice from |
Thank you for your pull request! The most important CI builds succeeded, we’ll review the pull request soon. |
Although this is a bug! We should keep documentation like it is and fix the TypeScript compilation |
How will we fix the TypeScript compilation for that? Isn't this the work of babel? |
That's an opinion and everything is relative. That's not the issue here. @hemal7735 No, we use TypeScript for compiling the code. What I would expect from the compilation is something like this: Before export default something() {} After module.exports = something() {} Instead, TypeScript does something dumb and consider |
It will still do if we have both module.exports = something() {} if default is the only export. Maybe it's a feature request for both babel and tsc 😅 |
What kind of change does this PR introduce?
README docs
Did you add tests for your changes? NA
If relevant, did you update the documentation? NA
Summary
I found out while playing around with the examples given in the doc.
We transpile the
ts
files using babel which convertsexport default [func/variables]
to
Does this PR introduce a breaking change? No