tool-shack 0.0.5 → 0.0.9

package/dist/general/isValidJson.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check if string is valid JSON
+ *
+ * @param value String value to be checked
+ * @returns Boolean indicating if string value is a valid JSON
+ */
+export declare const isValidJson: (value: string) => boolean;

package/dist/general/isValidJson.js

@@ -0,0 +1,16 @@
+/**
+ * Check if string is valid JSON
+ *
+ * @param value String value to be checked
+ * @returns Boolean indicating if string value is a valid JSON
+ */
+export const isValidJson = (value) => {
+    try {
+        JSON.parse(value);
+    }
+    catch (error) {
+        return false;
+    }
+    return true;
+};
+//# sourceMappingURL=isValidJson.js.map

package/dist/general/isValidJson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isValidJson.js","sourceRoot":"","sources":["../../src/general/isValidJson.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAa,EAAW,EAAE;IACpD,IAAI;QACF,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACnB;IAAC,OAAO,KAAU,EAAE;QACnB,OAAO,KAAK,CAAC;KACd;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC"}

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,OAAO,CAAC;AACtB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC"}

package/dist/schedule/index.d.ts

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

package/dist/schedule/index.js

@@ -1,2 +1,3 @@
+export * from './runAnimation';
 export * from './runAsync';
 //# sourceMappingURL=index.js.map

package/dist/schedule/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schedule/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schedule/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC"}

package/dist/schedule/runAnimation.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Run function as animation using requestAnimationFrame
+ *
+ * @param fn Function to be run as animation
+ * @param autoStart If animation should start right away or just return callbacks
+ * @returns Callbacks to start animation (startAnimation) and stop animation (stopAnimation)
+ */
+export declare const runAnimation: (fn: () => any, autoStart?: boolean) => {
+    startAnimation: () => void;
+    stopAnimation: () => void;
+};

package/dist/schedule/runAnimation.js

@@ -0,0 +1,40 @@
+/**
+ * Run function as animation using requestAnimationFrame
+ *
+ * @param fn Function to be run as animation
+ * @param autoStart If animation should start right away or just return callbacks
+ * @returns Callbacks to start animation (startAnimation) and stop animation (stopAnimation)
+ */
+export const runAnimation = (fn, autoStart = true) => {
+    let isRunning = false;
+    let requestedAnimationFrame = null;
+    const runAnimation = () => {
+        requestedAnimationFrame = requestAnimationFrame(() => {
+            fn.call(this);
+            if (isRunning) {
+                runAnimation();
+            }
+        });
+    };
+    const startAnimation = () => {
+        if (isRunning) {
+            return;
+        }
+        isRunning = true;
+        runAnimation();
+    };
+    const stopAnimation = () => {
+        if (!isRunning) {
+            return;
+        }
+        isRunning = false;
+        if (!!requestedAnimationFrame) {
+            cancelAnimationFrame(requestedAnimationFrame);
+        }
+    };
+    if (autoStart) {
+        startAnimation();
+    }
+    return { startAnimation, stopAnimation };
+};
+//# sourceMappingURL=runAnimation.js.map

package/dist/schedule/runAnimation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runAnimation.js","sourceRoot":"","sources":["../../src/schedule/runAnimation.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,EAAa,EACb,SAAS,GAAG,IAAI,EAC2C,EAAE;IAC7D,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,IAAI,uBAAuB,GAAkB,IAAI,CAAC;IAElD,MAAM,YAAY,GAAG,GAAS,EAAE;QAC9B,uBAAuB,GAAG,qBAAqB,CAAC,GAAS,EAAE;YACzD,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEd,IAAI,SAAS,EAAE;gBACb,YAAY,EAAE,CAAC;aAChB;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,GAAS,EAAE;QAChC,IAAI,SAAS,EAAE;YACb,OAAO;SACR;QAED,SAAS,GAAG,IAAI,CAAC;QACjB,YAAY,EAAE,CAAC;IACjB,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,GAAS,EAAE;QAC/B,IAAI,CAAC,SAAS,EAAE;YACd,OAAO;SACR;QAED,SAAS,GAAG,KAAK,CAAC;QAElB,IAAI,CAAC,CAAC,uBAAuB,EAAE;YAC7B,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;SAC/C;IACH,CAAC,CAAC;IAEF,IAAI,SAAS,EAAE;QACb,cAAc,EAAE,CAAC;KAClB;IAED,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,CAAC;AAC3C,CAAC,CAAC"}

package/dist/schedule/runAsync.d.ts

@@ -1 +1,7 @@
+/**
+ * Run function in asynchronously in Worker
+ *
+ * @param fn Function to be run asynchronously
+ * @returns Promise of expected result
+ */
 export declare const runAsync: <T>(fn: () => any) => Promise<T>;

package/dist/schedule/runAsync.js

@@ -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 = (fn) => {
     const worker = new Worker(URL.createObjectURL(new Blob([`postMessage((${fn})());`])));
     return new Promise((res, rej) => {

package/dist/schedule/runAsync.js.map

@@ -1 +1 @@
-{"version":3,"file":"runAsync.js","sourceRoot":"","sources":["../../src/schedule/runAsync.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAK,EAAa,EAAc,EAAE;IACxD,MAAM,MAAM,GAAG,IAAI,MAAM,CACvB,GAAG,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC,CAC3D,CAAC;IAEF,OAAO,IAAI,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC9B,MAAM,CAAC,SAAS,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;YAC9B,GAAG,CAAC,IAAI,CAAC,CAAC;YACV,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,CAAC,CAAC;QAEF,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC,EAAE;YACrB,GAAG,CAAC,GAAG,CAAC,CAAC;YACT,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}
+{"version":3,"file":"runAsync.js","sourceRoot":"","sources":["../../src/schedule/runAsync.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAK,EAAa,EAAc,EAAE;IACxD,MAAM,MAAM,GAAG,IAAI,MAAM,CACvB,GAAG,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC,CAC3D,CAAC;IAEF,OAAO,IAAI,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC9B,MAAM,CAAC,SAAS,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;YAC9B,GAAG,CAAC,IAAI,CAAC,CAAC;YACV,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,CAAC,CAAC;QAEF,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC,EAAE;YACrB,GAAG,CAAC,GAAG,CAAC,CAAC;YACT,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/string/escapeHTML.d.ts

@@ -1 +1,7 @@
+/**
+ * Escape special HTML related characters from string
+ *
+ * @param html String containing HTML related characters
+ * @returns Safe string with escaped HTML related characters
+ */
 export declare const escapeHTML: (html: string) => string;

package/dist/string/escapeHTML.js

@@ -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) => {
     const tempDiv = document.createElement('div');
     tempDiv.innerText = html;

package/dist/string/escapeHTML.js.map

@@ -1 +1 @@
-{"version":3,"file":"escapeHTML.js","sourceRoot":"","sources":["../../src/string/escapeHTML.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAU,EAAE;IACjD,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9C,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAEzB,OAAO,OAAO,CAAC,SAAS,CAAC;AAC3B,CAAC,CAAA"}
+{"version":3,"file":"escapeHTML.js","sourceRoot":"","sources":["../../src/string/escapeHTML.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAU,EAAE;IACjD,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9C,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAEzB,OAAO,OAAO,CAAC,SAAS,CAAC;AAC3B,CAAC,CAAA"}

package/dist/string/index.d.ts

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

package/dist/string/index.js

@@ -1,2 +1,5 @@
 export * from './escapeHTML';
+export * from './removeDiacritics';
+export * from './slugify';
+export * from './truncate';
 //# sourceMappingURL=index.js.map

package/dist/string/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC"}

package/dist/string/removeDiacritics.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Remove diacritics & accents from string
+ *
+ * @param value String from which should be removed diacritics & accents
+ * @returns ASCII string with removed diacritics & accents
+ */
+export declare const removeDiacritics: (value: string) => string;

package/dist/string/removeDiacritics.js

@@ -0,0 +1,11 @@
+/**
+ * Remove diacritics & accents from string
+ *
+ * @param value String from which should be removed diacritics & accents
+ * @returns ASCII string with removed diacritics & accents
+ */
+export const removeDiacritics = (value) => value
+    .normalize('NFD')
+    .toString()
+    .replace(/[\u0300-\u036f]/g, '');
+//# sourceMappingURL=removeDiacritics.js.map

package/dist/string/removeDiacritics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"removeDiacritics.js","sourceRoot":"","sources":["../../src/string/removeDiacritics.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAU,EAAE,CACxD,KAAK;KACF,SAAS,CAAC,KAAK,CAAC;KAChB,QAAQ,EAAE;KACV,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC"}

package/dist/string/slugify.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 declare const slugify: (value: string, separator?: string) => string;

package/dist/string/slugify.js

@@ -0,0 +1,16 @@
+import { removeDiacritics } from './removeDiacritics';
+/**
+ * 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, separator = '-') => {
+    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);
+};
+//# sourceMappingURL=slugify.js.map

package/dist/string/slugify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slugify.js","sourceRoot":"","sources":["../../src/string/slugify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,YAAoB,GAAG,EAAU,EAAE;IACxE,SAAS,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC;IACpD,MAAM,gBAAgB,GAAG,IAAI,MAAM,CAAC,aAAa,SAAS,GAAG,EAAE,GAAG,CAAC,CAAC;IAEpE,OAAO,gBAAgB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;SAChD,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC;SAC7B,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAChC,CAAC,CAAC"}

package/dist/string/truncate.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Truncate string to maximum given length if needed and append string at the end (by default "...")
+ *
+ * @param value String value to be truncated
+ * @param maxLength Maximum allowed length
+ * @param appendedString String to append at the end, be default "..."
+ * @returns Truncated value if needed otherwise original value
+ */
+export declare const truncate: (value: string, maxLength: number, appendedString?: string) => string;

package/dist/string/truncate.js

@@ -0,0 +1,17 @@
+/**
+ * Truncate string to maximum given length if needed and append string at the end (by default "...")
+ *
+ * @param value String value to be truncated
+ * @param maxLength Maximum allowed length
+ * @param appendedString String to append at the end, be default "..."
+ * @returns Truncated value if needed otherwise original value
+ */
+export const truncate = (value, maxLength, appendedString = '...') => {
+    if (maxLength < appendedString.length) {
+        return appendedString.slice(0, maxLength);
+    }
+    return value.length > maxLength
+        ? value.slice(0, maxLength - appendedString.length) + appendedString
+        : value;
+};
+//# sourceMappingURL=truncate.js.map

package/dist/string/truncate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"truncate.js","sourceRoot":"","sources":["../../src/string/truncate.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,KAAa,EACb,SAAiB,EACjB,iBAAyB,KAAK,EACtB,EAAE;IACV,IAAI,SAAS,GAAG,cAAc,CAAC,MAAM,EAAE;QACrC,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;KAC3C;IAED,OAAO,KAAK,CAAC,MAAM,GAAG,SAAS;QAC7B,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,GAAG,cAAc,CAAC,MAAM,CAAC,GAAG,cAAc;QACpE,CAAC,CAAC,KAAK,CAAC;AACZ,CAAC,CAAC"}

package/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/assets/highlight.css

@@ -0,0 +1,22 @@
+:root {
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --code-background: var(--dark-code-background);
+} }
+
+body.light {
+    --code-background: var(--light-code-background);
+}
+
+body.dark {
+    --code-background: var(--dark-code-background);
+}
+
+pre, code { background: var(--code-background); }