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

{{#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}}
{{{methodDescription}}}
{{#if params}}

Parameters:

    {{#params}}
  • {{#if optional}} [{{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}} [{{name}}{{#if optdefault}}={{optdefault}}{{/if}}] {{#crossLink type}}{{/crossLink}} optional {{else}} {{name}} {{#crossLink type}}{{/crossLink}} {{/if}}
      {{{description}}}
      {{#if props}}
        {{#props}}
      • {{#if optional}} [{{name}}{{#if optdefault}}={{optdefault}}{{/if}}] {{#crossLink type}}{{/crossLink}} optional {{else}} {{name}} {{#crossLink type}}{{/crossLink}} {{/if}}
        {{{description}}}
        • {{/props}}
      {{/if}}
      • {{/props}}
    {{/if}}
    • {{/params}}
{{/if}} {{#return}}

Returns:

{{#if description}} {{#if type}} {{#crossLink type}}{{/crossLink}}: {{/if}} {{{description}}} {{else}} {{#if type}} {{#crossLink type}}{{/crossLink}}: {{/if}} {{/if}}
{{/return}} {{#example}}

Example:

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