[doc] document that asyncReplace and asyncAppend accept an option…

…al mapper function (#1292)
lit · Jan 12, 2024 · 493860b · 493860b
1 parent ffd4049
commit 493860b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 6 deletions.
diff --git a/packages/lit-dev-content/site/docs/v2/templates/directives.md b/packages/lit-dev-content/site/docs/v2/templates/directives.md
@@ -1831,7 +1831,10 @@ import {asyncAppend} from 'lit/directives/async-append.js';
 <td class="wide-cell">
 
 ```ts
-asyncAppend(iterable: AsyncIterable)
+asyncAppend(
+  iterable: AsyncIterable<I>,
+  mapper?: (item: I, index?: number) => unknown
+)
 ```
 
 </td>
@@ -1924,7 +1927,10 @@ import {asyncReplace} from 'lit/directives/async-replace.js';
 <td class="wide-cell">
 
 ```ts
-asyncReplace(iterable: AsyncIterable)
+asyncReplace(
+  iterable: AsyncIterable<I>,
+  mapper?: (item: I, index?: number) => unknown
+)
 ```
 
 </td>
@@ -1933,7 +1939,7 @@ asyncReplace(iterable: AsyncIterable)
 <td class="no-wrap-cell vcenter-cell">Usable location</td>
 <td class="wide-cell">
 
-Child expression
+Any expression
 
 </td>
 </tr>

diff --git a/packages/lit-dev-content/site/docs/v3/templates/directives.md b/packages/lit-dev-content/site/docs/v3/templates/directives.md
@@ -1831,7 +1831,10 @@ import {asyncAppend} from 'lit/directives/async-append.js';
 <td class="wide-cell">
 
 ```ts
-asyncAppend(iterable: AsyncIterable)
+asyncAppend(
+  iterable: AsyncIterable<I>,
+  mapper?: (item: I, index?: number) => unknown
+)
 ```
 
 </td>
@@ -1924,7 +1927,10 @@ import {asyncReplace} from 'lit/directives/async-replace.js';
 <td class="wide-cell">
 
 ```ts
-asyncReplace(iterable: AsyncIterable)
+asyncReplace(
+  iterable: AsyncIterable<I>,
+  mapper?: (item: I, index?: number) => unknown
+)
 ```
 
 </td>
@@ -1933,7 +1939,7 @@ asyncReplace(iterable: AsyncIterable)
 <td class="no-wrap-cell vcenter-cell">Usable location</td>
 <td class="wide-cell">
 
-Child expression
+Any expression
 
 </td>
 </tr>