Val Town is a social website to write and deploy JavaScript.
Build APIs and schedule functions from your browser.
Comments
3
stevekrouse avatar

Can simplify the top comment like I mentioned on the other ones

I'm surprised that your JSDoc strings are on the object and not on the functions themselves. Does that show up when you reference them in another Val Editor?

Cool that you did the params and return types and throws. I don't know if all that data is necessary. Check it out and send over screenshots?

Would be neat to export all these methods as well

andreterron avatar

I'm surprised that your JSDoc strings are on the object and not on the functions themselves.

Yeah, if I add them to the function, they're not displayed when hovering on blob.setJSON.

Would be neat to export all these methods as well

Unless there's a way to "re-use" a JSDoc comment, we'd likely need to duplicate the JSDocs for that. I think it would be weird exporting the method AND a blob object. I could see it making sense using the default export, but then it would break the interface. And since there are some vals that use the unversioned blob import, I don't think it's worth it right now.

Cool that you did the params and return types and throws. [...] send over screenshots?

The Promise<void> returns looked empty, so I removed them. Otherwise, here's a screenshot:

image.png

stevekrouse avatar

Perfect! Ready to merge!

For the future (or now if you wanted to experiment) I'm wondering if we should show example usage in the jsdoc string as well. That could be super handy to have right at hand...

Updated: April 3, 2024