{{name}}

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

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.

{{/providedBy}}

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

{{#if deprecationMessage}}

Deprecated: {{deprecationMessage}}

{{/if}} {{#if since}}

Available since {{since}}

{{/if}}
{{{eventDescription}}}
{{#if params}}

Parameters:

{{#params}} {{#if optional}} {{/if}} {{/params}}
nametypeflagdescription
[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}] {{#crossLink type}}{{/crossLink}} optional {{else}} {{name}} {{#crossLink type}}{{/crossLink}} {{/if}} {{#if multiple}} multiple {{/if}}
{{{description}}}
{{#if props}} {{#props}} {{#if optional}} {{/if}} {{/props}}
nametypeflagdescription
[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}] {{#crossLink type}}{{/crossLink}} optional {{else}} {{name}} {{#crossLink type}}{{/crossLink}} {{/if}} {{#if multiple}} multiple {{/if}}
{{{description}}}
{{#if props}} {{#props}} {{#if optional}} {{/props}}
nametypeflagdescription
[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}] {{#crossLink type}}{{/crossLink}} optional {{else}} {{name}} {{#crossLink type}}{{/crossLink}} {{/if}} {{#if multiple}} multiple {{/if}}
{{{description}}}
{{/if}} {{#example}}

Example:

{{{.}}}
{{/example}}