[patch] add JSDoc comments to cleanup and render init methods

Author: electrovir

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@electrovir/element-vir-mono-repo",
-    "version": "26.14.4",
+    "version": "26.14.5",
     "private": true,
     "repository": {
         "type": "git",

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@electrovir/element-vir-example",
-    "version": "26.14.4",
+    "version": "26.14.5",
     "private": true,
     "license": "(MIT or CC0 1.0)",
     "author": {
@@ -18,7 +18,7 @@
         "@augment-vir/assert": "^31.67.0",
         "@augment-vir/common": "^31.67.0",
         "element-book": "^26.17.0",
-        "element-vir": "*",
+        "element-vir": "^26.14.5",
         "vira": "^30.1.0"
     },
     "devDependencies": {

packages/element-vir-example/package.json

@@ -188,7 +188,9 @@ export const MyWithUpdateState = defineElement()({
         return html`
             <span
                 ${listen('click', () => {
-                    updateState({username: 'new name!'});
+                    updateState({
+                        username: 'new name!',
+                    });
                 })}
             >
                 Hello there ${state.username}!
@@ -278,7 +280,14 @@ export const MyWithEvents = defineElement()({
             <button ${listen('click', () => dispatch(new events.logoutClick()))}>log out</button>
             <button
                 ${listen('click', () =>
-                    dispatch(new events.randomNumber(randomInteger({min: 0, max: 1_000_000}))),
+                    dispatch(
+                        new events.randomNumber(
+                            randomInteger({
+                                min: 0,
+                                max: 1_000_000,
+                            }),
+                        ),
+                    ),
                 )}
             >
                 generate random number
@@ -314,7 +323,9 @@ export const MyWithEventListening = defineElement()({
                     console.info('logout triggered');
                 })}
                 ${listen(MyWithEvents.events.randomNumber, (event) => {
-                    updateState({myNumber: event.detail});
+                    updateState({
+                        myNumber: event.detail,
+                    });
                 })}
             ></${MyWithEvents}>
             <span>${state.myNumber}</span>
@@ -360,7 +371,14 @@ export const MyWithCustomEvents = defineElement()({
             >
                 <div
                     ${listen('click', () => {
-                        dispatch(new MyCustomActionEvent(randomInteger({min: 0, max: 1_000_000})));
+                        dispatch(
+                            new MyCustomActionEvent(
+                                randomInteger({
+                                    min: 0,
+                                    max: 1_000_000,
+                                }),
+                            ),
+                        );
                     })}
                 ></div>
             </div>

packages/element-vir/README.md

@@ -1,6 +1,6 @@
 {
     "name": "element-vir",
-    "version": "26.14.4",
+    "version": "26.14.5",
     "keywords": [
         "custom",
         "web",

packages/element-vir/package.json

@@ -89,6 +89,7 @@ export type DeclarativeElementInit<
               TestIds
           >
         | undefined;
+    /** Called whenever an element updates. This creates the element's HTML. */
     render: RenderCallback<
         TagName,
         Inputs,
@@ -99,6 +100,7 @@ export type DeclarativeElementInit<
         SlotNames,
         TestIds
     >;
+    /** Called whenever an element is detached from the DOM. */
     cleanup?:
         | InitCallback<
               TagName,
@@ -111,5 +113,6 @@ export type DeclarativeElementInit<
               TestIds
           >
         | undefined;
+    /** Extra element definition options. */
     options?: Partial<DeclarativeElementDefinitionOptions> | undefined;
 };

packages/element-vir/src/declarative-element/declarative-element-init.ts

@@ -14,12 +14,10 @@ describe('HtmlInterpolation', () => {
         assert.tsType<{something: string}>().notMatches<HtmlInterpolation>();
         html`
             hello there
-            ${
+            ${{
                 // @ts-expect-error raw objects are not allowed
-                {
-                    something: 'hi',
-                }
-            }
+                something: 'hi',
+            }}
         `;
         assert.tsType<{something: string}>().notMatches<DirectiveOutput>();
     });