Skip to content

Commit

Permalink
Add small amount of documentation to describe how to render a Templat…
Browse files Browse the repository at this point in the history
…eResult
  • Loading branch information
AndrewJakubowicz committed May 9, 2022
1 parent 49fb48e commit e276e50
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions packages/lit-html/src/lit-html.ts
Expand Up @@ -446,9 +446,14 @@ const COMMENT_PART = 7;
* The return type of the template tag functions, {@linkcode html} and
* {@linkcode svg}.
*
* This object captures the arguments passed into the tag function. A special
* array of strings that retain their identity between multiple evaluations of
* the tagged literal, and the values from the interpolated expressions.
* The `TemplateResult` object captures the arguments passed into the tag
* function. A special array of strings that retain their identity between
* multiple evaluations of the tagged literal, and the values from the
* interpolated expressions.
*
* To create or update DOM from the `TemplateResult` you need to render the
* `TemplateResult`. See [Rendering](https://lit.dev/docs/components/rendering)
* for more information.
*/
export type TemplateResult<T extends ResultType = ResultType> = {
// This property needs to remain unminified.
Expand Down

0 comments on commit e276e50

Please sign in to comment.