Skip to content

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

Description

@davestewart

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 {

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions