Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to set examples on interfaces #147

Open
adamf321 opened this issue Feb 1, 2022 · 1 comment
Open

How to set examples on interfaces #147

adamf321 opened this issue Feb 1, 2022 · 1 comment

Comments

@adamf321
Copy link

adamf321 commented Feb 1, 2022

Is there a way to use @example on an interface, perhaps similar to how @ISINT works in the JSDoc?

Something like the docs doesn't work of course:

@Example...
effectiveDate?: Date;
@thawankeane
Copy link

thawankeane commented Jun 29, 2022

+1

But I think that isn't possible at this moment.

The better aproach to this would be something like this:

/**
 * Effective date
 * @example "2022-06-29"
 */
effectiveDate?: Date;

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants