Add return types for toHTML

conversejs · Dec 2, 2023 · d018e35 · d018e35
1 parent abc4446
commit d018e35
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/src/element.js b/src/element.js
@@ -1,3 +1,7 @@
+
+/**
+ * @typedef {import('lit-html').TemplateResult} TemplateResult
+ */
 import uniqueId from 'lodash-es/uniqueId.js';
 import { render } from 'lit-html';
 import EventEmitter from './eventemitter.js';
@@ -94,6 +98,9 @@ class ElementView extends EventEmitter(HTMLElement) {
     return this;
   }
 
+  /**
+   * @returns {string|TemplateResult}
+   */
   toHTML() {
     return '';
   }

diff --git a/src/types/element.d.ts b/src/types/element.d.ts
@@ -1,4 +1,5 @@
 export default ElementView;
+export type TemplateResult = import('lit-html').TemplateResult;
 declare const ElementView_base: {
     new (...args: any[]): {
         on(name: string, callback: (event: any, model: import("./model.js").Model, collection: import("./collection.js").Collection, options?: Record<string, any>) => any, context: any): any;
@@ -62,7 +63,10 @@ declare class ElementView extends ElementView_base {
      * convention is for **render** to always return `this`.
      */
     render(): this;
-    toHTML(): string;
+    /**
+     * @returns {string|TemplateResult}
+     */
+    toHTML(): string | TemplateResult;
     /**
      * Set callbacks, where `this.events` is a hash of
      *

diff --git a/src/types/element.d.ts.map b/src/types/element.d.ts.map