API Extractor VS JSDoc

API Extractor Reviews

JSDoc Reviews

API Extractor mentions (4)

• In-Depth guide for TypeScript Library

  There are many more tools than those listed above. You can check out discussion and comparison of bundling tools. Unfortunately, choosing the right tool among them is a process that you'll have to experiment with and decide for your own project needs. For example, dts-bundle-generator, API Extractor, and rollup-plugin-dts do not support .d.ts.map files. Also, API Extractor and dts-bundle-generator do not have... - Source: dev.to / 6 months ago

• I created a game engine using TypeScript. Please roast it.

  I use https://api-extractor.com/ at work and really like it. The problem with it is that the spec it follows doesn’t 100% match VSCode’s behavior. This causes pain when using {@link} fields in descriptions. Typedoc looks fine too, I’ve never used it. Source: about 1 year ago

• [AskJS] Managing private packages and published types in a monorepo

  I've tried using https://api-extractor.com/ to rollup types but it has some edge cases where it fails. Source: about 1 year ago

• Do you use JSdocs with TypeScript?

  I use TSDoc extensively at work, along with API Extractor to generate externally-facing documentation from the TSDoc comments. It’s great. Since I’ve gotten used to good intellisense in VSCode I don’t really like working in code that doesn’t have TSDoc comments anymore. Source: over 2 years ago

JSDoc mentions (49)

• Figma's Journey to TypeScript

  You may like JSDoc[1] if you just want some type-safety from the IDE without the compilation overhead. It’s done wonders when I’ve had to wrangle poorly commented legacy JavaScript codebases where most of the overhead is tracing what type the input parameters are. Personally, I’m impartial to TypeScript or JSDoc at this point. But I’d rather have either over plain JavaScript. [1] https://jsdoc.app/. - Source: Hacker News / 2 days ago

• Eloquent JavaScript 4th edition (2024)

  I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead. [1] https://jsdoc.app/. - Source: Hacker News / about 2 months ago

• Add typing to your Javascript code (without Typescript, kinda) ✍🏼

  The best way to do this, of course, is with JSDoc. But something I always found awkward about jsdoc is defining the object types in the same file. So, after a lot of reading, I found a way to combine JSDoc with declaration type files from Typescript. Let me give you an example:. - Source: dev.to / 3 months ago

• What is JSDoc and why you may not need typescript for your next project?

  There is a lot of specific symbols presented on the JSDOC specification that can be found here: https://jsdoc.app. - Source: dev.to / 3 months ago

• TypeScript Might Not Be Your God: Case Study of Migration from TS to JSDoc

  JSDoc is a specification for the comment format in JavaScript. This specification allows developers to describe the structure of their code, data types, function parameters, and much more using special comments. These comments can then be transformed into documentation using appropriate tools. - Source: dev.to / 4 months ago