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

[api-extractor ]support for @defaultvalue or @default and @type #720

Closed
RueDeRennes opened this issue Jun 23, 2018 · 2 comments
Closed

[api-extractor ]support for @defaultvalue or @default and @type #720

RueDeRennes opened this issue Jun 23, 2018 · 2 comments

Comments

@RueDeRennes
Copy link

RueDeRennes commented Jun 23, 2018

is there any support for @DefaultValue or @default and @type?
in my usecase:
`
/**

 * Gets or the `role` property. The role is depending on the actions count.
 * Posible values are: `dialog` | `alertdialog` | `alert`
 * @public
 * @type `boolean`
 * @defaultvalue `''`
 */
readonly role: string;

`

@RueDeRennes RueDeRennes changed the title support for @defaultvalue or @default support for @defaultvalue or @default and @type Jun 23, 2018
@octogonz
Copy link
Collaborator

What is the role of @type, given that the TypeScript language already has a full type system?

The @default tag seems like a pretty useful feature. Could you also open an issue for the TSDoc project to propose adding @default to the standard?

@octogonz octogonz changed the title support for @defaultvalue or @default and @type [api-extractor ]support for @defaultvalue or @default and @type Jun 26, 2018
@octogonz
Copy link
Collaborator

I opened microsoft/tsdoc#27 to track this. I'm closing this issue since @type seems to be already handled by the type system (although note that there is a JSDoc-in-JavaScript scenario that might be relevant.

Feel free to reopen this issue if you have more questions specific to API Extractor.

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