From 914b559a8a91061ee095211d659a1433b6656115 Mon Sep 17 00:00:00 2001 From: Timotej Ecimovic Date: Tue, 22 Sep 2020 08:12:33 -0400 Subject: [PATCH] Regen the apidoc. --- docs/api.md | 62 +++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 53 insertions(+), 9 deletions(-) diff --git a/docs/api.md b/docs/api.md index ca9c9481b4..3e1690674b 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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) ⇒ @@ -1209,7 +1209,7 @@ Given db connection, session and a single template package, produce the output. -### 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. @@ -1220,7 +1220,7 @@ executing promises for each, and collecting them into the outgoing string. | Param | Type | Description | | ----------- | --------------- | ---------------------------------------- | | resultArray | \* | | -| fn | \* | | +| options | \* | Options passed from a block helper. | | context | \* | The context from within this was called. | @@ -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) ⇒ @@ -1506,6 +1509,47 @@ Block helper that iterates over the package options of a given category. | category | \* | | options | \* | + + +### 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 [Templating API: toplevel utility helpers](#module*Templating API* toplevel utility helpers) +**Returns**: count + +| Param | Type | +| ------- | --------------- | +| options | \* | + + + +### 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 [Templating API: toplevel utility helpers](#module*Templating API* toplevel utility helpers) +**Returns**: content, if it's the first element inside an operator, empty otherwise. + +| Param | Type | +| ------- | --------------- | +| options | \* | + + + +### 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 [Templating API: toplevel utility helpers](#module*Templating API* toplevel utility helpers) +**Returns**: content, if it's the last element inside an operator, empty otherwise. + +| Param | Type | +| ------- | --------------- | +| options | \* | + ## Templating API: static zcl helpers @@ -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) ⇒ @@ -1901,7 +1945,7 @@ Given db connection, session and a single template package, produce the output. -### 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. @@ -1912,7 +1956,7 @@ executing promises for each, and collecting them into the outgoing string. | Param | Type | Description | | ----------- | --------------- | ---------------------------------------- | | resultArray | \* | | -| fn | \* | | +| options | \* | Options passed from a block helper. | | context | \* | The context from within this was called. | @@ -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) ⇒ @@ -2116,7 +2160,7 @@ Given db connection, session and a single template package, produce the output. -### 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. @@ -2127,7 +2171,7 @@ executing promises for each, and collecting them into the outgoing string. | Param | Type | Description | | ----------- | --------------- | ---------------------------------------- | | resultArray | \* | | -| fn | \* | | +| options | \* | Options passed from a block helper. | | context | \* | The context from within this was called. |