question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

CleanShot 2021-10-27 at 20 24 03@2x

In the above it would be nice to know more about what email is. I think it means that it will validate for a valid email. However there is also isEmail. Generally JSDoc would be great for docs.

Also, if you rely on https://paka.dev/npm/zod for your docs then you’ll get to re-use your JSDoc for your website doc. Full disclaimer I am the co-creator of Paka.

– edit: Oh looks like docs extraction for Zod on Paka is broken, I’ll look into that. For a working example you can check out https://paka.dev/npm/nexus.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:10 (1 by maintainers)

github_iconTop GitHub Comments

6reactions
jasonkuhrtcommented, Jul 5, 2022

bump

3reactions
stale[bot]commented, Jun 28, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Getting Started with JSDoc 3
JSDoc 3 is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor. You add documentation comments directly to your source code, ......
Read more >
Document your Javascript code with JSDoc - DEV Community ‍ ‍
Simply call jsdoc and add the path to the file or folder. ... To include many files or folders, add all their paths...
Read more >
JSDoc comments | WebStorm Documentation - JetBrains
WebStorm recognizes JSDoc comments and helps you create them by ... clear the Insert documentation comment stub checkbox in the Enter area.
Read more >
jsdoc - npm
JSDoc supports stable versions of Node.js 12.0.0 and later. You can install JSDoc globally or in your project's node_modules folder.
Read more >
How to use JSDoc - Basics & Introduction - YouTube
In this video tutorial I'll be demonstrating how to use JSDoc which can be used to document and annotate your JavaScript code.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found