tool-shack 0.0.5 → 0.0.6

package/src/dom/addAsyncEventListener.ts

@@ -1,3 +1,11 @@
+/**
+ * Listen to events fired on elements that may currently not exist in the DOM
+ *
+ * @param elementSelector Selector for element(s) to match event target
+ * @param listeners List of event types and related callback(s)
+ * @param acceptBubbling Boolean switch to allow bubbling or accept only direct element match
+ * @returns void
+ */
 export const addAsyncEventListener = (
   elementSelector: string,
   listeners: Record<string, EventListener | EventListener[]>,

package/src/dom/addEventListener.ts

@@ -1,3 +1,10 @@
+/**
+ * Add event listener(s) to one or more Node elements
+ *
+ * @param element One or multiple Node element(s) to set listener(s) for
+ * @param listeners List of event types and related callback(s)
+ * @returns void
+ */
 export const addEventListener = (
   element: HTMLElement | HTMLElement[] | NodeListOf<HTMLElement> | HTMLCollectionOf<HTMLElement>,
   listeners: Record<string, EventListenerOrEventListenerObject | EventListenerOrEventListenerObject[]>

package/src/dom/appendAfter.ts

@@ -1,2 +1,9 @@
+/**
+ * Append given node after reference node in the DOM
+ *
+ * @param newNode New node element to be appended
+ * @param referenceNode Reference node element
+ * @returns Result of the action
+ */
 export const appendAfter = (newNode: HTMLElement, referenceNode: HTMLElement): boolean =>
   !!referenceNode.parentElement?.insertBefore(newNode, referenceNode.nextSibling);

package/src/dom/appendBefore.ts

@@ -1,2 +1,9 @@
+/**
+ * Append given node before reference node in the DOM
+ *
+ * @param newNode New node element to be appended
+ * @param referenceNode Reference node element
+ * @returns Result of the action
+ */
 export const appendBefore = (newNode: HTMLElement, referenceNode: HTMLElement): boolean =>
   !!referenceNode.parentElement?.insertBefore(newNode, referenceNode);

package/src/dom/createElement.ts

@@ -1,5 +1,12 @@
 import { IExtendingElementProps } from './interfaces/createElement';
 
+/**
+ * Method for creating Node element and assigning multiple parameters, event listeners & children in one method call
+ *
+ * @param tagName Node tag name
+ * @param props List of attributes, event listeners or/and children to assign to the newly created element
+ * @returns Resulting Node element
+ */
 export const createElement = <T = HTMLElement> (tagName: string, props?: Partial<Omit<T, 'children'>> & IExtendingElementProps): T => {
   const element: HTMLElement = document.createElement(tagName);
 

package/src/dom/fireEvent.ts

@@ -1 +1,8 @@
+/**
+ * Manually fire event on Node element
+ *
+ * @param element Node element on which should be fired event
+ * @param eventType Type name of event that should be fired
+ * @returns Result of the action
+ */
 export const fireEvent = (element: HTMLElement, eventType: string): boolean => element.dispatchEvent(new Event(eventType));

package/src/dom/index.ts

@@ -1,3 +1,5 @@
+export * from './interfaces';
+
 export * from './addAsyncEventListener';
 export * from './addEventListener';
 export * from './appendAfter';

package/src/dom/interfaces/index.ts

@@ -0,0 +1 @@
+export * from './createElement';

package/src/schedule/runAsync.ts

@@ -1,3 +1,9 @@
+/**
+ * Run function in asynchronously in Worker
+ *
+ * @param fn Function to be run asynchronously
+ * @returns Promise of expected result
+ */
 export const runAsync = <T> (fn: () => any): Promise<T> => {
   const worker = new Worker(
     URL.createObjectURL(new Blob([`postMessage((${fn})());`])),

package/src/string/escapeHTML.ts

@@ -1,3 +1,9 @@
+/**
+ * Escape special HTML related characters from string
+ *
+ * @param html String containing HTML related characters
+ * @returns Safe string with escaped HTML related characters
+ */
 export const escapeHTML = (html: string): string => {
   const tempDiv = document.createElement('div');
   tempDiv.innerText = html;

package/tsconfig.json

@@ -13,12 +13,7 @@
     "baseUrl": ".",
     "declaration": true,
     "outDir": "./dist",
-    "lib": [
-      "dom",
-      "es2018"
-    ],
+    "lib": ["dom", "es2021"]
   },
-  "include": [
-    "src/**/*.ts"
-  ]
+  "include": ["src/**/*.ts"]
 }