{{name}} {{#if params}}
(
    {{#params}}
  • {{#if optional}} [{{name}} {{#if optdefault}}={{optdefault}}{{/if}}] {{else}} {{name}} {{/if}}
    • {{/params}}
)
{{else}} ( ) {{/if}} {{#if return}} {{#crossLink return.type}}{{/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 foundAt}} `{{{file}}}:{{{line}}}` {{/if}}

{{#if overwritten_from}}

{{i18n.INHERITED_FROM}} {{overwritten_from/class}} {{#if foundAt}} but overwritten in {{/if}} {{else}} {{#if extendedFrom}} {{#shouldShowInherit extendedFrom}}

{{@root.i18n.INHERITED_FROM}} {{../extendedFrom}}: {{/shouldShowInherit}} {{/if}} {{/if}} {{#if deprecationMessage}}

{{i18n.DEPRECATED}}: {{deprecationMessage}}

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

{{i18n.AVAILABLE_SINCE}} {{since}}

{{/if}} {{#if process}}
process: {{#process}} {{.}} {{/process}}
{{/if}}
{{{description}}}
{{#if params}}
{{#if optdefault}} {{/if}} {{#params}} {{#if optdefault}} {{/if}} {{/params}}
{{i18n.NAME}} {{i18n.TYPE}}{{i18n.DEFAULTS}}{{i18n.DESCRIPTION}}
{{#if optional}} {{name}} optional {{else}} {{name}} {{/if}} {{#crossLink type}}{{/crossLink}} {{optdefault}} {{{description}}} {{#if props}}
    {{#props}}
  • {{#if optional}} {{name}} {{#crossLink type}}{{/crossLink}} optional {{#if optdefault}} , default: {{optdefault}} {{/if}} {{else}} {{name}} {{#crossLink type}}{{/crossLink}} {{/if}}
    {{{description}}}
    {{#if props}}
      {{#props}}
    • {{#if optional}} {{name}} {{#crossLink type}}{{/crossLink}} optional {{#if optdefault}} , default: {{optdefault}} {{/if}} {{else}} {{name}} {{#crossLink type}}{{/crossLink}} {{/if}}
      {{{description}}}
      • {{/props}}
    {{/if}}
    • {{/props}}
{{/if}}
{{/if}} {{#return}}

{{../i18n.RETURNS}}:

{{#if type}} {{@root.i18n.TYPE}}: {{#crossLink type}}{{/crossLink}} {{/if}} {{#if description}}

{{{description}}}

{{/if}}
{{/return}} {{#example}}

{{../i18n.EXAMPLES}}:

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