Inherited from {{overwritten_from/class}} {{#if foundAt}} but overwritten in {{/if}} {{else}} {{#if extended_from}}

Inherited from {{extended_from}}: {{else}} {{#providedBy}}

Provided by the {{.}} module.

{{#if foundAt}} Defined in {{/if}} {{/if}} {{/if}} {{#if foundAt}} `{{{file}}}:{{{line}}}` {{/if}}

Deprecated: {{deprecationMessage}}

Available since {{since}}

Syntax

`{{name}}`

{{#crossLink type}}{{/crossLink}} {{#if deprecated}} deprecated {{/if}} {{#if access}} {{access}} {{/if}} {{#if final}} final {{/if}} {{#if static}} static {{/if}}

Summary

{{{eventDescription}}}

Event Payload:

{{#if optional}} [{{name}}{{#if optdefault}}={{optdefault}}{{/if}}] {{#crossLink type}}{{/crossLink}} optional {{else}} {{name}} {{#crossLink type}}{{/crossLink}} {{/if}} {{#if multiple}} Multiple {{/if}}
{{{description}}}
{{#if props}}
- {{#if optional}} [{{name}}{{#if optdefault}}={{optdefault}}{{/if}}] {{#crossLink type}}{{/crossLink}} optional {{else}} {{name}} {{#crossLink type}}{{/crossLink}} {{/if}}
  {{{description}}}
  {{#if props}}
  - {{name}} {{#crossLink type}}{{/crossLink}}
    {{{description}}}
  {{/if}}
{{/if}}

Example:

{{{.}}}