Update documentation for async functions

2026-01-09 07:27:56 -05:00 · 2018-02-25 12:21:13 -06:00
parent 10d0f19d36
commit bd5be52459
1 changed files with 5 additions and 0 deletions
--- a/docs/jsdoc/template-functions.jsdoc
+++ b/docs/jsdoc/template-functions.jsdoc
@@ -5,6 +5,8 @@
 * @callback TemplateFunction
 * @param {Object}          [locals={}]
 * an object of data to be passed into the template.
+ * @return {(String|Promise<String>)}
+ * Return type depends on {@link Options}`.async`.
 * @static
 * @global
 */
@@ -30,6 +32,9 @@
 * @param {RethrowCallback} [rethrow={@link module:ejs-internal.rethrow}]
 * callback used to handle and rethrow errors
 *
+ * @return {(String|Promise<String>)}
+ * Return type depends on {@link Options}`.async`.
+ *
 * @static
 * @global
 */