tool-shack 0.0.16 → 0.0.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tool-shack",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "description": "Collection of usefull functions to ease work",
   "author": {
     "name": "David Myška",
@@ -42,7 +42,7 @@
     "husky": "^8.0.1",
     "prettier": "^2.7.1",
     "pretty-quick": "^3.1.3",
-    "typedoc": "^0.23.5",
-    "typescript": "^4.7.4"
+    "typedoc": "^0.23.11",
+    "typescript": "^4.8.2"
   }
 }

package/src/browser/index.ts

@@ -1,7 +1,7 @@
-export * from './isPushNotificationSupported.js';
-export * from './isScrollBehaviorSupported.js';
-export * from './isShareSupported.js';
-export * from './isTabFocused.js';
-export * from './isTouchSupported.js';
-export * from './preferColorScheme.js';
-export * from './tabFocusListener.js';
+export * from './isPushNotificationSupported.js';
+export * from './isScrollBehaviorSupported.js';
+export * from './isShareSupported.js';
+export * from './isTabFocused.js';
+export * from './isTouchSupported.js';
+export * from './preferColorScheme.js';
+export * from './tabFocusListener.js';

package/src/browser/isScrollBehaviorSupported.ts

@@ -1,7 +1,7 @@
-/**
- * Check if user's browser supports setting scroll behavior
- *
- * @returns Boolean indicating if user's browser supports setting scroll behavior
- */
-export const isScrollBehaviorSupported = (): boolean =>
-  !!('scrollBehavior' in document.documentElement.style);
+/**
+ * Check if user's browser supports setting scroll behavior
+ *
+ * @returns Boolean indicating if user's browser supports setting scroll behavior
+ */
+export const isScrollBehaviorSupported = (): boolean =>
+  !!('scrollBehavior' in document.documentElement.style);

package/src/browser/isTouchSupported.ts

@@ -1,11 +1,11 @@
-import { IExtendedWindow } from './interfaces/isTouchSupported.js';
-
-/**
- * Check if user's browser supports touch events
- *
- * @returns Boolean indicating if user's browser supports touch events
- */
-export const isTouchSupported = (): boolean =>
-  'ontouchstart' in window ||
-  ((window as unknown as IExtendedWindow).DocumentTouch &&
-    document instanceof (window as unknown as IExtendedWindow).DocumentTouch);
+import { IExtendedWindow } from './interfaces/isTouchSupported.js';
+
+/**
+ * Check if user's browser supports touch events
+ *
+ * @returns Boolean indicating if user's browser supports touch events
+ */
+export const isTouchSupported = (): boolean =>
+  'ontouchstart' in window ||
+  ((window as unknown as IExtendedWindow).DocumentTouch &&
+    document instanceof (window as unknown as IExtendedWindow).DocumentTouch);

package/src/browser/tabFocusListener.ts

@@ -1,18 +1,18 @@
-import { isTabFocused } from './isTabFocused.js';
-
-/**
- * Set callbacks for if current browser tab is in focus
- *
- * @param focusCallback Function to be called when current browser tab goes into focus
- * @param blurCallback Function to be called when current browser tab goes out of focus
- * @returns void
- */
-export const tabFocusListener = (focusCallback?: () => void, blurCallback?: () => void): void => {
-  document.addEventListener('visibilitychange', () => {
-    if (isTabFocused()) {
-      focusCallback?.call(this);
-    } else {
-      blurCallback?.call(this);
-    }
-  });
-};
+import { isTabFocused } from './isTabFocused.js';
+
+/**
+ * Set callbacks for if current browser tab is in focus
+ *
+ * @param focusCallback Function to be called when current browser tab goes into focus
+ * @param blurCallback Function to be called when current browser tab goes out of focus
+ * @returns void
+ */
+export const tabFocusListener = (focusCallback?: () => void, blurCallback?: () => void): void => {
+  document.addEventListener('visibilitychange', () => {
+    if (isTabFocused()) {
+      focusCallback?.call(this);
+    } else {
+      blurCallback?.call(this);
+    }
+  });
+};

package/src/dateTime/index.ts

@@ -1,4 +1,4 @@
-export * from './interfaces/index.js';
-
-export * from './dateAsIso.js';
-export * from './parseDuration.js';
+export * from './interfaces/index.js';
+
+export * from './dateAsIso.js';
+export * from './parseDuration.js';

package/src/dateTime/interfaces/index.ts

@@ -1 +1 @@
-export * from './parseDuration.js';
+export * from './parseDuration.js';

package/src/dateTime/parseDuration.ts

@@ -1,19 +1,19 @@
-import { IDuration } from './interfaces/parseDuration.js';
-
-/**
- * Parse duration in milliseconds into days, hours, minutes, seconds, milliseconds
- *
- * @param durationInMs Integer of duration in milliseconds
- * @returns Object containing days, hours, minutes, seconds and milliseconds of provided duration
- */
-export const parseDuration = (durationInMs: number): IDuration => {
-  durationInMs = Math.abs(durationInMs);
-
-  return {
-    days: Math.floor(durationInMs / (24 * 60 * 60 * 1000)),
-    hours: Math.floor(durationInMs / (60 * 60 * 1000)) % 24,
-    minutes: Math.floor(durationInMs / (60 * 1000)) % 60,
-    seconds: Math.floor(durationInMs / 1000) % 60,
-    milliseconds: Math.floor(durationInMs) % 1000,
-  };
-};
+import { IDuration } from './interfaces/parseDuration.js';
+
+/**
+ * Parse duration in milliseconds into days, hours, minutes, seconds, milliseconds
+ *
+ * @param durationInMs Integer of duration in milliseconds
+ * @returns Object containing days, hours, minutes, seconds and milliseconds of provided duration
+ */
+export const parseDuration = (durationInMs: number): IDuration => {
+  durationInMs = Math.abs(durationInMs);
+
+  return {
+    days: Math.floor(durationInMs / (24 * 60 * 60 * 1000)),
+    hours: Math.floor(durationInMs / (60 * 60 * 1000)) % 24,
+    minutes: Math.floor(durationInMs / (60 * 1000)) % 60,
+    seconds: Math.floor(durationInMs / 1000) % 60,
+    milliseconds: Math.floor(durationInMs) % 1000,
+  };
+};

package/src/dom/createElement.ts

@@ -1,55 +1,55 @@
-import { IExtendingElementProps } from './interfaces/createElement.js';
-
-/**
- * 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' | 'dataset' | 'style'>> & IExtendingElementProps,
-): T => {
-  const element: HTMLElement = document.createElement(tagName);
-
-  if (props) {
-    for (let key in props) {
-      const value = (props as any)[key];
-
-      if (key === 'role') {
-        element.setAttribute(key, value);
-      } else if (key === 'aria') {
-        for (let ariaKey in props.aria!) {
-          element.setAttribute(`aria-${ariaKey}`, value[ariaKey]);
-        }
-      } else if (key === 'style') {
-        for (let styleKey in props.style!) {
-          (element.style as any)[styleKey] = value[styleKey];
-        }
-      } else if (key === 'children') {
-        props.children!.forEach((child: HTMLElement) => element.appendChild(child));
-      } else if (key === 'listeners') {
-        for (let eventName in props.listeners!) {
-          const functionList = (
-            props.listeners![eventName] instanceof Array
-              ? props.listeners![eventName]
-              : [props.listeners![eventName]]
-          ) as EventListenerOrEventListenerObject[];
-
-          functionList.forEach((fn: EventListenerOrEventListenerObject) =>
-            element.addEventListener(eventName, fn),
-          );
-        }
-      } else if (key === 'dataset') {
-        for (let datasetKey in props.dataset) {
-          element.dataset[datasetKey] = props.dataset[datasetKey];
-        }
-      } else {
-        (element as any)[key] = value;
-      }
-    }
-  }
-
-  return element as unknown as T;
-};
+import { IExtendingElementProps } from './interfaces/createElement.js';
+
+/**
+ * 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' | 'dataset' | 'style'>> & IExtendingElementProps,
+): T => {
+  const element: HTMLElement = document.createElement(tagName);
+
+  if (props) {
+    for (let key in props) {
+      const value = (props as any)[key];
+
+      if (key === 'role') {
+        element.setAttribute(key, value);
+      } else if (key === 'aria') {
+        for (let ariaKey in props.aria!) {
+          element.setAttribute(`aria-${ariaKey}`, value[ariaKey]);
+        }
+      } else if (key === 'style') {
+        for (let styleKey in props.style!) {
+          (element.style as any)[styleKey] = value[styleKey];
+        }
+      } else if (key === 'children') {
+        props.children!.forEach((child: HTMLElement) => element.appendChild(child));
+      } else if (key === 'listeners') {
+        for (let eventName in props.listeners!) {
+          const functionList = (
+            props.listeners![eventName] instanceof Array
+              ? props.listeners![eventName]
+              : [props.listeners![eventName]]
+          ) as EventListenerOrEventListenerObject[];
+
+          functionList.forEach((fn: EventListenerOrEventListenerObject) =>
+            element.addEventListener(eventName, fn),
+          );
+        }
+      } else if (key === 'dataset') {
+        for (let datasetKey in props.dataset) {
+          element.dataset[datasetKey] = props.dataset[datasetKey];
+        }
+      } else {
+        (element as any)[key] = value;
+      }
+    }
+  }
+
+  return element as unknown as T;
+};

package/src/dom/index.ts

@@ -1,9 +1,9 @@
-export * from './interfaces/index.js';
-
-export * from './addAsyncEventListener.js';
-export * from './addClickOutsideListener.js';
-export * from './addEventListener.js';
-export * from './appendAfter.js';
-export * from './appendBefore.js';
-export * from './createElement.js';
-export * from './fireEvent.js';
+export * from './interfaces/index.js';
+
+export * from './addAsyncEventListener.js';
+export * from './addClickOutsideListener.js';
+export * from './addEventListener.js';
+export * from './appendAfter.js';
+export * from './appendBefore.js';
+export * from './createElement.js';
+export * from './fireEvent.js';

package/src/dom/interfaces/index.ts

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

package/src/general/index.ts

@@ -1,3 +1,3 @@
-export * from './isEmpty.js';
-export * from './isNil.js';
-export * from './isValidJson.js';
+export * from './isEmpty.js';
+export * from './isNil.js';
+export * from './isValidJson.js';

package/src/general/isEmpty.ts

@@ -1,21 +1,21 @@
-import { isNil } from './isNil.js';
-
-/**
- * Check if given value is empty
- *
- * @param value Value to be checked
- * @returns Boolean indicating if given value is empty
- */
-export const isEmpty = (value: any): boolean => {
-  if (value instanceof Function) {
-    return false;
-  }
-
-  return (
-    isNil(value) ||
-    (value instanceof Object &&
-      !Object.keys(value).length &&
-      Object.getPrototypeOf(value) === Object.prototype) ||
-    !value.valueOf().toString().length
-  );
-};
+import { isNil } from './isNil.js';
+
+/**
+ * Check if given value is empty
+ *
+ * @param value Value to be checked
+ * @returns Boolean indicating if given value is empty
+ */
+export const isEmpty = (value: any): boolean => {
+  if (value instanceof Function) {
+    return false;
+  }
+
+  return (
+    isNil(value) ||
+    (value instanceof Object &&
+      !Object.keys(value).length &&
+      Object.getPrototypeOf(value) === Object.prototype) ||
+    !value.valueOf().toString().length
+  );
+};

package/src/index.ts

@@ -1,6 +1,6 @@
-export * from './browser/index.js';
-export * from './dateTime/index.js';
-export * from './dom/index.js';
-export * from './general/index.js';
-export * from './schedule/index.js';
-export * from './string/index.js';
+export * from './browser/index.js';
+export * from './dateTime/index.js';
+export * from './dom/index.js';
+export * from './general/index.js';
+export * from './schedule/index.js';
+export * from './string/index.js';

package/src/schedule/index.ts

@@ -1,2 +1,2 @@
-export * from './runAnimation.js';
-export * from './runAsync.js';
+export * from './runAnimation.js';
+export * from './runAsync.js';

package/src/string/index.ts

@@ -1,5 +1,5 @@
-export * from './byteSize.js';
-export * from './escapeHTML.js';
-export * from './removeDiacritics.js';
-export * from './slugify.js';
-export * from './truncate.js';
+export * from './byteSize.js';
+export * from './escapeHTML.js';
+export * from './removeDiacritics.js';
+export * from './slugify.js';
+export * from './truncate.js';

package/src/string/slugify.ts

@@ -1,17 +1,17 @@
-import { removeDiacritics } from './removeDiacritics.js';
-
-/**
- * Create slug from given string
- *
- * @param value String to be slugified
- * @param separator One character to be used as separator (if provided longer than one character, will be automatically shortened), dash ('-') by default
- * @returns Slugified string
- */
-export const slugify = (value: string, separator: string = '-'): string => {
-  separator = separator.trim().substring(0, 1) || '-';
-  const removeCharsRegex = new RegExp(`[^\\\w\\\s${separator}]`, 'g');
-
-  return removeDiacritics(value.trim().toLowerCase())
-    .replace(removeCharsRegex, '')
-    .replace(/\s+/g, separator);
-};
+import { removeDiacritics } from './removeDiacritics.js';
+
+/**
+ * Create slug from given string
+ *
+ * @param value String to be slugified
+ * @param separator One character to be used as separator (if provided longer than one character, will be automatically shortened), dash ('-') by default
+ * @returns Slugified string
+ */
+export const slugify = (value: string, separator: string = '-'): string => {
+  separator = separator.trim().substring(0, 1) || '-';
+  const removeCharsRegex = new RegExp(`[^\\\w\\\s${separator}]`, 'g');
+
+  return removeDiacritics(value.trim().toLowerCase())
+    .replace(removeCharsRegex, '')
+    .replace(/\s+/g, separator);
+};