[reactive-element] Add types to query, query-async, and queryAll jsdo…

…c code examples (#2688) * Add types to query, query-async, and queryAll code examples * Add changeset
lit · Apr 8, 2022 · ef178ef · ef178ef
1 parent 6022c98
commit ef178ef
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/.changeset/rude-jokes-fetch.md b/.changeset/rude-jokes-fetch.md
@@ -0,0 +1,6 @@
+---
+'@lit/reactive-element': patch
+'lit': patch
+---
+
+Add explicit types to the jsdoc code samples for `query`, `queryAll`, and `queryAsync`.
diff --git a/packages/reactive-element/src/decorators/query-all.ts b/packages/reactive-element/src/decorators/query-all.ts
@@ -26,7 +26,7 @@ import {decorateProperty} from './base.js';
  * ```ts
  * class MyElement {
  *   @queryAll('div')
- *   divs;
+ *   divs: NodeListOf<HTMLDivElement>;
  *
  *   render() {
  *     return html`

diff --git a/packages/reactive-element/src/decorators/query-async.ts b/packages/reactive-element/src/decorators/query-async.ts
@@ -34,7 +34,7 @@ import {decorateProperty} from './base.js';
  * ```ts
  * class MyElement {
  *   @queryAsync('#first')
- *   first;
+ *   first: Promise<HTMLDivElement>;
  *
  *   render() {
  *     return html`

diff --git a/packages/reactive-element/src/decorators/query.ts b/packages/reactive-element/src/decorators/query.ts
@@ -27,7 +27,7 @@ import {decorateProperty} from './base.js';
  * ```ts
  * class MyElement {
  *   @query('#first')
- *   first;
+ *   first: HTMLDivElement;
  *
  *   render() {
  *     return html`