# {{pkg.name}}@{{pkg.version}}

{{pkg.description}}

+ Functions
{{#each signature.functions}}
  + [{{name}}({{paramDesc}})](#{{{spinalcase ../pkg.name}}}-function-{{spinalcase name}})
{{/each}}
{{#each signature.classes}}
+ [`{{name}}`](#{{{spinalcase ../pkg.name}}}-class) Class
{{#with constructor}}
  + [new {{../name}}({{paramDesc}})](#{{{spinalcase ../../pkg.name}}}-class-{{spinalcase ../name}}-constructor)
{{/with}}
{{#each functions}}
  + [{{../instanceName}}.{{name}}({{paramDesc}})](#{{{spinalcase ../../pkg.name}}}-class-{{spinalcase ../name}}-{{name}})
{{/each}}
{{/each}}

## Functions

{{#each signature.functions}}
<a class='md-heading-link' name="{{{spinalcase ../pkg.name}}}-function-{{spinalcase name}}" ></a>

### {{name}}({{paramDesc}}){{#if returns.type}} -> `{{{returns.type}}}`{{/if}}

{{{description}}}
{{#if parameters}}

| Param | Type | Description |
| ----- | --- | -------- |
{{#each parameters}}
| {{name}} | {{type}} | {{{description}}} |
{{/each}}

{{/if}}
{{#if examples}}
**Example**:

```javascript
{{#each examples}}
{{{this}}}
{{/each}}
```
{{/if}}
{{/each}}

{{#each signature.classes}}

<a class='md-heading-link' name="{{{spinalcase ../pkg.name}}}-class"></a>

## `{{name}}` Class

{{description}}{{constructor.description}}

{{#if extends.[0]}}
**Extends**:

{{#each extends}}+ `{{{this}}}`
{{/each}}{{/if}}

{{#with constructor}}

<a class='md-heading-link' name="{{{spinalcase ../../pkg.name}}}-class-{{spinalcase ../name}}-constructor" ></a>

### new {{../name}}({{paramDesc}})

Constructor of {{../name}} class

{{#if parameters}}
| Param | Type | Description |
| ----- | --- | -------- |
{{#each parameters}}
| {{name}} | {{type}} | {{{description}}} |
{{/each}}
{{/if}}
{{#if examples}}
**Example**:

```javascript
{{#each examples}}
{{{this}}}
{{/each}}
```
{{/if}}

{{/with}}
{{#each functions}}

<a class='md-heading-link' name="{{{spinalcase ../../pkg.name}}}-class-{{spinalcase ../name}}-{{name}}" ></a>

### {{../instanceName}}.{{name}}({{paramDesc}}){{#if returns.type}} -> `{{{returns.type}}}`{{/if}}

{{{description}}}
{{#if parameters}}

| Param | Type | Description |
| ----- | --- | -------- |
{{#each parameters}}
| {{name}} | {{type}} | {{{description}}} |
{{/each}}

{{/if}}
{{#if examples}}
**Example**:

```javascript
{{#each examples}}
{{{this}}}
{{/each}}
```
{{/if}}
{{/each}}
{{/each}}