#jsdoc — Public Fediverse posts

Maybe that's helpful for other devs using JSDoc: Import Types from other modules in JSDoc

https://grooovinger.com/notes/2026-02-12-import-types-from-other-modules

#til #jsdoc #ts #webdev

Maybe that's helpful for other devs using JSDoc: Import Types from other modules in JSDoc

https://grooovinger.com/notes/2026-02-12-import-types-from-other-modules

#til #jsdoc #ts #webdev

The not-so-new-anymore `@import` #JSDoc tag support that landed in TypeScript 5.5 makes it much, much nicer to import type definitions ✨

```
/** @import {Page, Post} from "../types.js" */

/**
* Build permalinks for pages and posts
* @param {Page | Post} entry
* @return {string}
*/
```

Great for keeping JSDoc blocks tidy, and especially nice when the same type is used multiple times throughout a single script.

https://multiline.co/mment/2024/02/importing-jsdoc-type-definitions/#typescript-5.5-or-newer

The not-so-new-anymore `@import` #JSDoc tag support that landed in TypeScript 5.5 makes it much, much nicer to import type definitions ✨

```
/** @import {Page, Post} from "../types.js" */

/**
* Build permalinks for pages and posts
* @param {Page | Post} entry
* @return {string}
*/
```

Great for keeping JSDoc blocks tidy, and especially nice when the same type is used multiple times throughout a single script.

https://multiline.co/mment/2024/02/importing-jsdoc-type-definitions/#typescript-5.5-or-newer

JSDocs в VSCode

Меня зовут Алекс Гусев. В этой публикации я очень кратко раскрываю, почему переход с IntelliJ IDEA (PhpStorm) на VSCode ломает привычную работу с JSDoc в JavaScript-проектах.

https://habr.com/ru/articles/980286/

#javascript #jsdoc #vscode #lsp #анализ_кода

So, apparently #JSDoc *is* #TypeScript now! 😂 In a twist no one saw coming, adding comments to #JavaScript is the same as a whole new language! 🚀 I'm sure the TypeScript devs are thrilled to hear their work boiled down to some docstring wizardry. 🙄
https://culi.bearblog.dev/jsdoc-is-typescript/ #developer #humor #coding #humor #HackerNews #ngated

So, apparently #JSDoc *is* #TypeScript now! 😂 In a twist no one saw coming, adding comments to #JavaScript is the same as a whole new language! 🚀 I'm sure the TypeScript devs are thrilled to hear their work boiled down to some docstring wizardry. 🙄
https://culi.bearblog.dev/jsdoc-is-typescript/ #developer #humor #coding #humor #HackerNews #ngated

JSDoc *Is* TypeScript

https://culi.bearblog.dev/jsdoc-is-typescript/

#HackerNews #JSDoc #TypeScript #Programming #Developer #Tools #Documentation

JSDoc *Is* TypeScript

https://culi.bearblog.dev/jsdoc-is-typescript/

#HackerNews #JSDoc #TypeScript #Programming #Developer #Tools #Documentation

The Nuances of JavaScript Typing Using JSDoc, by @jaredwhite (@vanillaweb):

https://thathtml.blog/2025/12/nuances-of-typing-with-jsdoc/

#javascript #jsdoc #typescript #dx

The Nuances of JavaScript Typing Using JSDoc, by @jaredwhite (@vanillaweb):

https://thathtml.blog/2025/12/nuances-of-typing-with-jsdoc/

#javascript #jsdoc #typescript #dx

JSDoc as the ideal typing tool for JavaScript. @vanillaweb argues that JavaScript, enhanced with JSDoc and TypeScript’s tsc for type checking, can deliver the same safety and clarity as TypeScript and without build complexity. He explains how to configure jsconfig.json and tsconfig.json, showing how JSDoc makes code self-documenting and flexible. #javascript #jsdoc

https://thathtml.blog/2025/12/nuances-of-typing-with-jsdoc/

JSDoc as the ideal typing tool for JavaScript. @vanillaweb argues that JavaScript, enhanced with JSDoc and TypeScript’s tsc for type checking, can deliver the same safety and clarity as TypeScript and without build complexity. He explains how to configure jsconfig.json and tsconfig.json, showing how JSDoc makes code self-documenting and flexible. #javascript #jsdoc

https://thathtml.blog/2025/12/nuances-of-typing-with-jsdoc/

JSDoc как идеальный инструмент типизации для JavaScript. Джаред Уайт утверждает, что JavaScript в сочетании с JSDoc и проверкой типов через TypeScript tsc обеспечивает ту же безопасность и ясность, что и TypeScript, но без лишней сборки. Он описывает настройку jsconfig.json и tsconfig.json и показывает, как JSDoc делает код самодокументируемым и гибким. #js #jsdoc

https://thathtml.blog/2025/12/nuances-of-typing-with-jsdoc/

JSDoc как идеальный инструмент типизации для JavaScript. Джаред Уайт утверждает, что JavaScript в сочетании с JSDoc и проверкой типов через TypeScript tsc обеспечивает ту же безопасность и ясность, что и TypeScript, но без лишней сборки. Он описывает настройку jsconfig.json и tsconfig.json и показывает, как JSDoc делает код самодокументируемым и гибким. #js #jsdoc

https://thathtml.blog/2025/12/nuances-of-typing-with-jsdoc/

#Development #Approaches
The nuances of JavaScript typing · “JavaScript + JSDoc + tsc should be the industry default.” https://ilo.im/168va0

_____
#EcmaScript #JavaScript #JSDoc #TypeScript #tsc #CLI #Tooling #WebDev #Frontend #Backend

#Development #Approaches
The nuances of JavaScript typing · “JavaScript + JSDoc + tsc should be the industry default.” https://ilo.im/168va0

_____
#EcmaScript #JavaScript #JSDoc #TypeScript #tsc #CLI #Tooling #WebDev #Frontend #Backend

#Development #Introductions
The killer feature of web components · A look at the Custom Elements Manifest initiative https://ilo.im/167mgm

_____
#WebComponents #TypeScript #JSDoc #JSON #API #WebDev #Frontend #HTML #CSS #JavaScript

#Development #Introductions
The killer feature of web components · A look at the Custom Elements Manifest initiative https://ilo.im/167mgm

_____
#WebComponents #TypeScript #JSDoc #JSON #API #WebDev #Frontend #HTML #CSS #JavaScript

@chriskirknielsen Quick idea : as #JSDoc seems highly similar to #PHPDoc and the original #Javadoc , you might have some luck with tools written for any of those as well.

@chriskirknielsen Quick idea : as #JSDoc seems highly similar to #PHPDoc and the original #Javadoc , you might have some luck with tools written for any of those as well.

Do any of you fellow nerds have a tool that parses (select) JS files for #JSDoc comments and spits out _something_ that can be used as-is or plugged into some kind of documentation template?

This project I'm on has about a zillion (well documented!) functions and I'd love to be able to share them with new team members. Instead of saying "uuuh yeah we have a timezone-stripping date function _somewhere_…", it would just be like "look up the docs, search for ‘date’" and presto badabingo. Thanks!

Do any of you fellow nerds have a tool that parses (select) JS files for #JSDoc comments and spits out _something_ that can be used as-is or plugged into some kind of documentation template?

This project I'm on has about a zillion (well documented!) functions and I'd love to be able to share them with new team members. Instead of saying "uuuh yeah we have a timezone-stripping date function _somewhere_…", it would just be like "look up the docs, search for ‘date’" and presto badabingo. Thanks!

Документирование фронтенд-приложений: обзор JSDoc и Storybook

В современной веб-разработке качественная документация так же важна, как и качественный код. Когда ваше приложение разрастается до десятков или сотен компонентов, функций и модулей, становится практически невозможно удерживать в памяти все детали их работы. Хорошая документация не только облегчает поддержку проекта в долгосрочной перспективе, но и значительно ускоряет вхождение новых разработчиков в команду. В этой статье мы рассмотрим два популярных подхода к документированию фронтенд-кода: JSDoc и Storybook. Они решают схожие задачи, но совершенно разными способами и с разным фокусом.

https://habr.com/ru/articles/905996/

#jsdoc #storybook #приложения #фронтент #документация

How JSDoc Saved My Dev Workflow, by (not on Mastodon or Bluesky):

https://spin.atomicobject.com/how-jsdoc-saved-my-dev-workflow/

#jsdoc #javascript #typescript #documentation

How JSDoc Saved My Dev Workflow, by (not on Mastodon or Bluesky):

https://spin.atomicobject.com/how-jsdoc-saved-my-dev-workflow/

#jsdoc #javascript #typescript #documentation

#javascript #jsdoc #typescript

Petite notation quand on veut typer un membre d'objet qui fait office de constructeur : ObjectConstructor<Object_Type>

Exemple :

interface TopBarApp {
enable: () => void;
disable: () => void;
}

type TopBarAppFactory = {
klass: ObjectConstructor<TopBarApp>,
}

#dev #web

#javascript #jsdoc #typescript

Petite notation quand on veut typer un membre d'objet qui fait office de constructeur : ObjectConstructor<Object_Type>

Exemple :

interface TopBarApp {
enable: () => void;
disable: () => void;
}

type TopBarAppFactory = {
klass: ObjectConstructor<TopBarApp>,
}

#dev #web

it's one of those grim ironies in life that #JSDoc, the standard library/format for writing #javascript / #typescript documentation, has some of the worst documentation i've ever had the misfortune of trying to read.

https://jsdoc.app/

it's one of those grim ironies in life that #JSDoc, the standard library/format for writing #javascript / #typescript documentation, has some of the worst documentation i've ever had the misfortune of trying to read.

https://jsdoc.app/

JS-TS monster v2.0 👾

#javascript #typescript #jsdoc

JS-TS monster v2.0 👾

#javascript #typescript #jsdoc

JS-TS monster v2.0 👾 #javascript #typescript #jsdoc

While working on porting the Small Technology Foundation web site¹ to Kitten², I took the opportunity to pull out base Model and Collection classes that I’ll likely end up including in Kitten proper:

• Model: https://codeberg.org/small-tech/site/src/branch/kitten/app_modules/database/Model.js
• Collection: https://codeberg.org/small-tech/site/src/branch/kitten/app_modules/database/Collection.js

To see them in use, here’s the base Posts class (with RSS generation) that extends Collection:
https://codeberg.org/small-tech/site/src/branch/kitten/app_modules/database/Posts.js

And here’s the concrete EventPosts collection class that extends Posts:
https://codeberg.org/small-tech/site/src/branch/kitten/app_modules/database/EventPosts.js

And the EventPost (showing an implementation of a calculated property):
https://codeberg.org/small-tech/site/src/branch/kitten/app_modules/database/EventPost.js

So all this is possible (persisting and reading back typed model collections, etc.) thanks to JSDB¹ (JavaScript database), a zero-dependency, transparent, in-memory, streaming write-on-update JavaScript database I wrote for the Small Web that persists to a JavaScript transaction log and is included as as first-class citizen in Kitten.

https://codeberg.org/small-tech/jsdb

And if you want to know how the magic mapping of classes happens, see the Database App Module:

https://codeberg.org/small-tech/site/src/branch/kitten/app_modules/database/database.js#L34

PS. For a much gentler introduction to persistence in Kitten, see the Kitten Persistence tutorial:
https://kitten.small-web.org/tutorials/persistence/

Enjoy! :kitten:💕

¹ https://small-tech.org
² https://kitten.small-web.org

#Kitten #SmallWeb #SmallTech #JavaScript #database #JSDB #typeSafety #JSDoc #closureCompiler #TypeScript #workInProgress

While working on porting the Small Technology Foundation web site¹ to Kitten², I took the opportunity to pull out base Model and Collection classes that I’ll likely end up including in Kitten proper:

• Model: https://codeberg.org/small-tech/site/src/branch/kitten/app_modules/database/Model.js
• Collection: https://codeberg.org/small-tech/site/src/branch/kitten/app_modules/database/Collection.js

To see them in use, here’s the base Posts class (with RSS generation) that extends Collection:
https://codeberg.org/small-tech/site/src/branch/kitten/app_modules/database/Posts.js

And here’s the concrete EventPosts collection class that extends Posts:
https://codeberg.org/small-tech/site/src/branch/kitten/app_modules/database/EventPosts.js

And the EventPost (showing an implementation of a calculated property):
https://codeberg.org/small-tech/site/src/branch/kitten/app_modules/database/EventPost.js

So all this is possible (persisting and reading back typed model collections, etc.) thanks to JSDB¹ (JavaScript database), a zero-dependency, transparent, in-memory, streaming write-on-update JavaScript database I wrote for the Small Web that persists to a JavaScript transaction log and is included as as first-class citizen in Kitten.

https://codeberg.org/small-tech/jsdb

And if you want to know how the magic mapping of classes happens, see the Database App Module:

https://codeberg.org/small-tech/site/src/branch/kitten/app_modules/database/database.js#L34

PS. For a much gentler introduction to persistence in Kitten, see the Kitten Persistence tutorial:
https://kitten.small-web.org/tutorials/persistence/

Enjoy! :kitten:💕

¹ https://small-tech.org
² https://kitten.small-web.org

#Kitten #SmallWeb #SmallTech #JavaScript #database #JSDB #typeSafety #JSDoc #closureCompiler #TypeScript #workInProgress

Looking for advice on how to refactor legacy #JavaScript #frontend code (My expertise is on backend).

I know how to write relatively clean JS / #TypeScript for frontend in modern setups with modern tooling, but I'm not sure how to proceed with thousands-of-lines long files that are directly included as they are, so I can transition to having smaller & cleaner files and using static analysis tools that give me some peace of mind.

My only achievement so far with my current project is that I run #BiomeJS on some selected files.

I'm relying on #JSDoc for now, but "for my eyes only", I'm not using this typing information to validate anything.

#refactoring #legacycode

Looking for advice on how to refactor legacy #JavaScript #frontend code (My expertise is on backend).

I know how to write relatively clean JS / #TypeScript for frontend in modern setups with modern tooling, but I'm not sure how to proceed with thousands-of-lines long files that are directly included as they are, so I can transition to having smaller & cleaner files and using static analysis tools that give me some peace of mind.

My only achievement so far with my current project is that I run #BiomeJS on some selected files.

I'm relying on #JSDoc for now, but "for my eyes only", I'm not using this typing information to validate anything.

#refactoring #legacycode

I'm adding #JSDoc on a non-typescript old web app I have to maintain. It's better than nothing!

#javacsript #typescript #webdev

#JSDoc ist einfach das bessere #TypeScript 😄

Je cherche en ce moment un outil de génération de #documentation #javascript .

J'utilise #jsdoc <https://jsdoc.app/> depuis des années mais j'essaye de voir s'il n'existe pas autre chose de plus simple et léger (écrire un modèle pour jsdoc c'est vraiment un calvaire !)

Je jette un œil du côté des #plugins de #vscode et les résultats de recherche sont maintenant pollué par tout un tas de conneries basées sur #ai .

Ce métier est foutu !

Je cherche en ce moment un outil de génération de #documentation #javascript .

J'utilise #jsdoc <https://jsdoc.app/> depuis des années mais j'essaye de voir s'il n'existe pas autre chose de plus simple et léger (écrire un modèle pour jsdoc c'est vraiment un calvaire !)

Je jette un œil du côté des #plugins de #vscode et les résultats de recherche sont maintenant pollué par tout un tas de conneries basées sur #ai .

Ce métier est foutu !

Trying to bring some type-checking to webc components in @eleventy via #jsdoc comments

Trying to bring some type-checking to webc components in @eleventy via #jsdoc comments

I looked for a #JavaScript framework that does not require a build step but still has good support for types with #JSDoc and has a functional API. The usual suspects, #Vue, #React and #lit do not fit this description.

I came across this tiny framework that does. https://github.com/grucloud/bau?tab=readme-ov-file#sample-code

Almost another year has passed and it’s still not possible to use JSDoc and have the TypeScript LSP understand when you’re referring to a class and when you’re referring to an instance…

*sigh*

https://github.com/jsdoc/jsdoc/issues/1349#issuecomment-1725400751

#JSDoc #TypeScript #web #dev

"Our approach to JSDoc has evolved since this issue was created. (...) #Typescript is the largest processor of #JSDoc at this point, and TS users who want typing are probably the most prolific authors of it."

https://github.com/microsoft/TypeScript/issues/27387#issuecomment-2273842157

Si vous voulez utiliser le typage de JSDoc parce que l'usage de TypeScript n'est pas possible dans votre situation.

JSDoc as an alternative TypeScript syntax
https://alexharri.com/blog/jsdoc-as-an-alternative-typescript-syntax

#typescript #jsdoc

If using Typescript means you want to write less Unit Tests then, actually, I'm all for it. Type away, with JSDoc comments.

But I'm still making you write end-to-end functional browser tests.

#typescript #unitTests #javaScript #types #typing #programming #webDev #jsdoc #jsdocs

One thing that's cool when you use #JavaScript #JSDoc instead of #TypeScript is that you can safely use a beta version of TS in your project: this will have no impact on the JS bundle, only on type checking!

(currently experimenting the new JSDoc type imports released with TS 5.5 Beta)

I can't wait for #TypeScript 5.5 to be released. I'm tired of writing long-winded type imports with #JavaScript #JSDoc.

https://devblogs.microsoft.com/typescript/announcing-typescript-5-5-beta/#type-imports-in-jsdoc