TypeScript and JSDoc: Enhancing Documentation and Type Safety

In this episode of Syntax, Wes and Scott use the fact that Svelte is being converted from TypeScript to JavaScript with JSDoc to talk about the benefits of working that way, why they are doing it, and what you can do with JSDoc that TypeScript alone doesn’t let you do.

• 00:10 Welcome

• 01:12 Roof update

• 02:15 TypeScript haters need not apply

• 03:17 What is JSDoc?

• 04:27 What is our history with JSDoc?

• 06:37 Why is Svelte moving to JSDoc?

• 08:11 Why is JSDoc better than TypeScript?

• 12:31 You can type things you can’t in TypeScript

• 16:37 Param, Function and returns Descriptions

• 21:32 Spoiler - it’s still TypeScript

• 33:23 SIIIIICK ××× PIIIICKS ×××

• Get Started With TypeScript the Easy Way

• TypeScript without TypeScript – JSDoc superpowers

• TypeScript: Documentation - JSDoc Reference

• Dev Vlog: April 2023 - TypeScript vs JSDoc, Transitions API, Dominic Gannaway joins Svelte team

• Svelte repo is finally being converted from Typescript to Javascript with JSDoc

• If you are on a JS project and are missing the TypeScript hinting in your editor, you can still type your code with JSDoc syntax comments and VS Code will detect and use it!

• Sprinkle in a little JSDoc on top of your TypeScript when needed - helpful to adding descriptions to returned values, or marking things as deprecated

• TypeScript to JSDoc

• Scott: Watch MerPeople | Netflix Official Site
• Wes: 18V ONE+ 45W HYBRID SOLDERING STATION (TOOL ONLY) | RYOBI Tools

• Scott: Sentry
• Wes: Wes Bos Tutorials

• Scott’s Instagram
• LevelUpTutorials Instagram
• Wes’ Instagram
• Wes’ Twitter
• Wes’ Facebook
• Scott’s Twitter
• Make sure to include @SyntaxFM in your tweets
• Wes Bos on Bluesky
• Scott on Bluesky
• Syntax on Bluesky