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

Can you use @fires on a class definition ? #188

Open
davestewart opened this issue Jun 7, 2018 · 0 comments
Open

Can you use @fires on a class definition ? #188

davestewart opened this issue Jun 7, 2018 · 0 comments

Comments

@davestewart
Copy link

davestewart commented Jun 7, 2018

Just trying to work out the best way to document components so that other devs know what to listen to:

  • @property = in
  • @fires = out

Does this look reasonable?

/**
 * Modal Component
 * 
 * @property closable  the modal is closable
 * @emits    close     the modal was closed (success)
 * @emits    cancel    the model was cancelled
 */
export default class {
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

1 participant