Skip to content

Commit

Permalink
Regen the apidoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
tecimovic committed Sep 22, 2020
1 parent b964472 commit 914b559
Showing 1 changed file with 53 additions and 9 deletions.
62 changes: 53 additions & 9 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1050,7 +1050,7 @@ Inserts bitmaps into the database. Data is an array of objects that must contain
- [~contentIndexer(content)](#module*JS API* generator logic..contentIndexer)
- [~generateSingleFileForPreview(db, sessionId, fileName)](#module*JS API* generator logic..generateSingleFileForPreview) ⇒
- [~produceContent(db, sessionId, singlePkg)](#module*JS API* generator logic..produceContent) ⇒
- [~collectBlocks(resultArray, fn, context)](#module*JS API* generator logic..collectBlocks) ⇒
- [~collectBlocks(resultArray, options, context)](#module*JS API* generator logic..collectBlocks) ⇒
- [~ensureZclPackageId(context)](#module*JS API* generator logic..ensureZclPackageId) ⇒
- [~ensureTemplatePackageId(context)](#module*JS API* generator logic..ensureTemplatePackageId) ⇒

Expand Down Expand Up @@ -1209,7 +1209,7 @@ Given db connection, session and a single template package, produce the output.

<a name="module_JS API_ generator logic..collectBlocks"></a>

### JS API: generator logic~collectBlocks(resultArray, fn, context) ⇒
### JS API: generator logic~collectBlocks(resultArray, options, context) ⇒

Helpful function that collects the individual blocks by using elements of an array as a context,
executing promises for each, and collecting them into the outgoing string.
Expand All @@ -1220,7 +1220,7 @@ executing promises for each, and collecting them into the outgoing string.
| Param | Type | Description |
| ----------- | --------------- | ---------------------------------------- |
| resultArray | <code>\*</code> | |
| fn | <code>\*</code> | |
| options | <code>\*</code> | Options passed from a block helper. |
| context | <code>\*</code> | The context from within this was called. |

<a name="module_JS API_ generator logic..ensureZclPackageId"></a>
Expand Down Expand Up @@ -1476,6 +1476,9 @@ This module contains the API for templating. For more detailed instructions, rea
- [~zap_header()](#module*Templating API* toplevel utility helpers..zap_header) ⇒
- [~ident()](#module*Templating API* toplevel utility helpers..ident) ⇒
- [~template_options(category, options)](#module*Templating API* toplevel utility helpers..template_options)
- [~last_count(options)](#module*Templating API* toplevel utility helpers..last_count) ⇒
- [~first(options)](#module*Templating API* toplevel utility helpers..first) ⇒
- [~last(options)](#module*Templating API* toplevel utility helpers..last) ⇒

<a name="module_Templating API_ toplevel utility helpers..zap_header"></a>

Expand Down Expand Up @@ -1506,6 +1509,47 @@ Block helper that iterates over the package options of a given category.
| category | <code>\*</code> |
| options | <code>\*</code> |

<a name="module_Templating API_ toplevel utility helpers..last_count"></a>

### Templating API: toplevel utility helpers~last_count(options) ⇒

Returns the last count of any iterator block that preceded this location in the templates

**Kind**: inner method of [<code>Templating API: toplevel utility helpers</code>](#module*Templating API* toplevel utility helpers)
**Returns**: count

| Param | Type |
| ------- | --------------- |
| options | <code>\*</code> |

<a name="module_Templating API_ toplevel utility helpers..first"></a>

### Templating API: toplevel utility helpers~first(options) ⇒

Inside an iterator, this helper allows you to specify the content that will be output only
during the first element.

**Kind**: inner method of [<code>Templating API: toplevel utility helpers</code>](#module*Templating API* toplevel utility helpers)
**Returns**: content, if it's the first element inside an operator, empty otherwise.

| Param | Type |
| ------- | --------------- |
| options | <code>\*</code> |

<a name="module_Templating API_ toplevel utility helpers..last"></a>

### Templating API: toplevel utility helpers~last(options) ⇒

Inside an iterator, this helper allows you to specify the content that will be output only
during the last element.

**Kind**: inner method of [<code>Templating API: toplevel utility helpers</code>](#module*Templating API* toplevel utility helpers)
**Returns**: content, if it's the last element inside an operator, empty otherwise.

| Param | Type |
| ------- | --------------- |
| options | <code>\*</code> |

<a name="module_Templating API_ static zcl helpers"></a>

## Templating API: static zcl helpers
Expand Down Expand Up @@ -1742,7 +1786,7 @@ zcl_cluster_largest_label_length
- [~contentIndexer(content)](#module*JS API* generator logic..contentIndexer)
- [~generateSingleFileForPreview(db, sessionId, fileName)](#module*JS API* generator logic..generateSingleFileForPreview) ⇒
- [~produceContent(db, sessionId, singlePkg)](#module*JS API* generator logic..produceContent) ⇒
- [~collectBlocks(resultArray, fn, context)](#module*JS API* generator logic..collectBlocks) ⇒
- [~collectBlocks(resultArray, options, context)](#module*JS API* generator logic..collectBlocks) ⇒
- [~ensureZclPackageId(context)](#module*JS API* generator logic..ensureZclPackageId) ⇒
- [~ensureTemplatePackageId(context)](#module*JS API* generator logic..ensureTemplatePackageId) ⇒

Expand Down Expand Up @@ -1901,7 +1945,7 @@ Given db connection, session and a single template package, produce the output.

<a name="module_JS API_ generator logic..collectBlocks"></a>

### JS API: generator logic~collectBlocks(resultArray, fn, context) ⇒
### JS API: generator logic~collectBlocks(resultArray, options, context) ⇒

Helpful function that collects the individual blocks by using elements of an array as a context,
executing promises for each, and collecting them into the outgoing string.
Expand All @@ -1912,7 +1956,7 @@ executing promises for each, and collecting them into the outgoing string.
| Param | Type | Description |
| ----------- | --------------- | ---------------------------------------- |
| resultArray | <code>\*</code> | |
| fn | <code>\*</code> | |
| options | <code>\*</code> | Options passed from a block helper. |
| context | <code>\*</code> | The context from within this was called. |

<a name="module_JS API_ generator logic..ensureZclPackageId"></a>
Expand Down Expand Up @@ -1957,7 +2001,7 @@ Returns the promise that resolves with the ZCL properties package id.
- [~contentIndexer(content)](#module*JS API* generator logic..contentIndexer)
- [~generateSingleFileForPreview(db, sessionId, fileName)](#module*JS API* generator logic..generateSingleFileForPreview) ⇒
- [~produceContent(db, sessionId, singlePkg)](#module*JS API* generator logic..produceContent) ⇒
- [~collectBlocks(resultArray, fn, context)](#module*JS API* generator logic..collectBlocks) ⇒
- [~collectBlocks(resultArray, options, context)](#module*JS API* generator logic..collectBlocks) ⇒
- [~ensureZclPackageId(context)](#module*JS API* generator logic..ensureZclPackageId) ⇒
- [~ensureTemplatePackageId(context)](#module*JS API* generator logic..ensureTemplatePackageId) ⇒

Expand Down Expand Up @@ -2116,7 +2160,7 @@ Given db connection, session and a single template package, produce the output.

<a name="module_JS API_ generator logic..collectBlocks"></a>

### JS API: generator logic~collectBlocks(resultArray, fn, context) ⇒
### JS API: generator logic~collectBlocks(resultArray, options, context) ⇒

Helpful function that collects the individual blocks by using elements of an array as a context,
executing promises for each, and collecting them into the outgoing string.
Expand All @@ -2127,7 +2171,7 @@ executing promises for each, and collecting them into the outgoing string.
| Param | Type | Description |
| ----------- | --------------- | ---------------------------------------- |
| resultArray | <code>\*</code> | |
| fn | <code>\*</code> | |
| options | <code>\*</code> | Options passed from a block helper. |
| context | <code>\*</code> | The context from within this was called. |

<a name="module_JS API_ generator logic..ensureZclPackageId"></a>
Expand Down

0 comments on commit 914b559

Please sign in to comment.