
    {{name}}
    {{#if params}}
        
            (
            {{#params}}
                
                    {{#if optional}}
                        [{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]
                    {{else}}
                        {{name}}
                    {{/if}}
                
            {{/params}}
            
)
        
    {{else}}
        ()
    {{/if}}

{{#if return}} {{#crossLink returnType}}{{/crossLink}} {{/if}} {{#if deprecated}} deprecated {{/if}} {{#if access}} {{access}} {{/if}} {{#if final}} final {{/if}} {{#if static}} static {{/if}} {{#if chainable}} chainable {{/if}} {{#if async}} async {{/if}}

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}}

{{{methodDescription}}}

Parameters:

name type flag description

[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]

optional {{else}}

{{name}}

{{/if}} {{#if multiple}} multiple {{/if}}

{{{description}}}

name type flag description

[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]

optional {{else}}

{{name}}

{{/if}} {{#if multiple}} multiple {{/if}}

{{{description}}}

name	type	flag	description
`[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]`	{{#crossLink type}}{{/crossLink}}	optional {{else}}	`{{name}}`	{{#crossLink type}}{{/crossLink}}	{{/if}} {{#if multiple}} multiple {{/if}}	{{{description}}}

Returns:

{{#if description}} {{#if type}} [{{#crossLink type}}{{/crossLink}}] {{/if}} {{{description}}} {{else}} {{#if type}} {{#crossLink type}}{{/crossLink}}: {{/if}} {{/if}}

Example:

{{this}}

{{{example}}}