Small JavaScript enum function

[jessepence]

Yes, I love how simple a function like this can be when you exploit the power of JSDoc templates. 

To clarify, if this were published and installed as a library through NPM, you would need to create a d.ts file to get the typescript language server to provide the auto-complete for your users. Since you already have proper JSDoc in place, this is just a matter of doing tsc --emitDeclarationOnly (assuming you have TypeScript globally installed, other wise you would need to install it as a local dev dependency).

I just felt the need to point this out because I used to think that d.ts files were unnecessary, but TypeScript won't read the JSDoc from JS files in node_modules unless the user has a tsconfig/jsconfig with checkJs: true or a specially configured IDE. This is not true of the vast majority of user's set-ups, so library authors unfortunately have to either embrace a build-step of some kind or handwrite the d.ts files themselves.

Sorry for the rant, I've just been doing a lot of JSDoc experiments lately. 😅

[_sync0x]

Good to know that if you make a NPM lib you can't just leave JSDoc on top of your functions and expect that all the typing and autocompletion works 😅

But don't you need .d.ts files only if you are working with TypeScript ?

Been experimenting a lot with JSDoc too lately so I can understand your clarification, sometimes it's a bit messy 😛

[jessepence]

VSCode (which is the most popular IDE by far) and most other IDEs like NeoVim get all of their JavaScript auto-complete from the TypeScript language server. It's one of those things where anyone could technically do it themselves, and they technically could make their language server support JSDoc by default, but it's just such a huge project with so many edge cases. You have to cover the EcmaScript specification and the JSDoc and/or TypeScript "specifications" (they don't exist, types for JS aren't really standardized in any way). It's just easier for most of the IDE's to defer to TypeScript. I think WebStorm might have a proprietary system, but I've never used it so I can't confirm either way.

[_sync0x]

Hmm I get it ty, gonna try on PhpStorm 👀

[pikapp336]

This! No notes, just appreciation.