-
Notifications
You must be signed in to change notification settings - Fork 8
Create an explainer / hub page for type stripping (TypeScript) support #34
Copy link
Copy link
Open
Labels
good first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
Enter your suggestions in details:
The new type stripping / TypeScript support in Node.js is very exciting. A lot of users are adopting the built-in support for both source code and tooling config files. 🚀
But, there isn't one single high-level, official resource that users can be pointed to to understand the unflagged support.
- https://nodejs.org/en/learn/typescript/run-natively is more of a runbook that shows how to use it, but doesn't explain much of the concepts. It's also out of date now that support is no longer experimental.
- https://satanacchio.hashnode.dev/everything-you-need-to-know-about-nodejs-type-stripping is not official. It feels weird pointing folks to a third party platform. It also has a lot of details on historical context and decision-making that users who just want to learn the high level of the feature wouldn't want to have to read through. (it is a great blog post on its own though!)
- https://nodejs.org/api/typescript.html#type-stripping is very technical and dives into the weeds of the module system.
Proposal: can the Node.js site have a page added dedicated to explaining type stripping at the high level? I'd imagine it could contain:
- What "type stripping" is
- Quick examples of running a
.tsfile - What versions of Node.js have it
- Quick FAQs such as un/not-yet-supported syntax and type checking
- Links to learn more on the official Node.js and TypeScript websites
Sibling issue to #35, intentionally with as similar an issue body as possible.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
good first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Type
Projects
Status
🔖 Ready