v1.1.0 - ready to publish

Author: patelka2211

DynamicColors.js

@@ -2,25 +2,25 @@
 
 # Dynamic Colors
 
-**Dynamic Colors** is a JavaScript library that can dynamically generate color theme from a single HEX color and it provides a range of useful APIs for creating, managing, and manipulating color themes such as [_create()_](#create), [_remove()_](#remove), [_setAutoTheme()_](#setautotheme), [_setDarkTheme()_](#setdarktheme), [_setLightTheme()_](#setlighttheme), [_themeCycle()_](#themecycle).
+**Dynamic Colors** is a JavaScript library that can dynamically generate color theme from a single HEX color and it provides a range of useful APIs for creating, managing, and manipulating color themes such as [_create()_](#create), [_remove()_](#remove), [_setAutoTheme()_](#setautotheme), [_setDarkTheme()_](#setdarktheme), [_setLightTheme()_](#setlighttheme), [_themeCycle()_](#themecycle), [_isInstance()_](#isinstance).
 
 ## Installation
 
 [![npm (scoped)](https://img.shields.io/npm/v/dynamic-colors)](https://www.npmjs.com/package/dynamic-colors)
-[![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/dynamic-colors)](https://bundlephobia.com/package/dynamic-colors@1.0.4)
+[![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/dynamic-colors)](https://bundlephobia.com/package/dynamic-colors@1.1.0)
 [![npm](https://img.shields.io/npm/dy/dynamic-colors)](https://www.npmjs.com/package/dynamic-colors)
-[![jsDelivr hits (npm scoped)](https://img.shields.io/jsdelivr/gh/hy/patelka2211/dynamic-colors)](https://cdn.jsdelivr.net/gh/patelka2211/dynamic-colors@1.0.4/)
+[![jsDelivr hits (npm scoped)](https://img.shields.io/jsdelivr/gh/hy/patelka2211/dynamic-colors)](https://cdn.jsdelivr.net/gh/patelka2211/dynamic-colors@1.1.0/)
 
 To install Dynamic Colors using npm, run the following command:
 
 ```sh
 npm i dynamic-colors
 ```
 
-Alternatively, you can include [Dynnamic Colors's IIFE file](https://cdn.jsdelivr.net/gh/patelka2211/dynamic-colors@1.0.4/DynamicColors.js) in your website using a `<script>` tag:
+Alternatively, you can include [Dynnamic Colors's IIFE file](https://cdn.jsdelivr.net/gh/patelka2211/dynamic-colors@1.1.0/DynamicColors.js) in your website using a `<script>` tag:
 
 ```html
-<script src="https://cdn.jsdelivr.net/gh/patelka2211/dynamic-colors@1.0.4/DynamicColors.js"></script>
+<script src="https://cdn.jsdelivr.net/gh/patelka2211/dynamic-colors@1.1.0/DynamicColors.js"></script>
 ```
 
 ## Available APIs
@@ -83,6 +83,10 @@ The [themeCycle()](#themecycle) function cycles through different themes based o
 -   If the current theme is `Light`, the next theme will be `Dark`.
 -   If the current theme is `Dark`, the next theme will be `Auto`.
 
+### isInstance()
+
+Determines whether the given object is an instance of [`DynamicColors`](#dynamiccolors-class). Returns `true` if the object is an instance of [`DynamicColors`](#dynamiccolors-class), otherwise `false`.
+
 ## Internally used functionalities
 
 ### DynamicColors class

README.md

@@ -1,6 +1,6 @@
 {
   "name": "dynamic-colors",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "Dynamic Colors is a JavaScript library that can dynamically generate color theme from a single HEX color and it provides a range of useful APIs for creating, managing, and manipulating color themes.",
   "main": "index.js",
   "module": "index.js",

package-lock.json

@@ -30,13 +30,12 @@ export class DynamicColors {
             this.styleTag.setAttribute("id", id);
             document.head.appendChild(this.styleTag);
             this.id = id;
+            this.setColor(HEXColor);
+            addInstance(this);
         } else
             throw Error(
-                `Unable to create another 'DynamicColors' instance with the name '${name}'. To modify the color of the tag with the name '${name}', please use the 'setColor()' method on the existing instance.`
+                `Unable to create another 'DynamicColors' instance with the name '${name}'.\n\nTo modify the color of the tag with the name '${name}', please use the 'setColor' method on the existing instance.`
             );
-
-        this.setColor(HEXColor);
-        addInstance(this);
     }
 
     /**
@@ -47,14 +46,15 @@ export class DynamicColors {
     public setColor(HEXColor: string) {
         let color = validateHEXColor(HEXColor);
 
-        if (!(typeof color === "boolean" && !color) && this.id !== undefined) {
-            this.styleTag.setAttribute("dc-color", color);
+        if (color === false)
+            throw Error(`"${HEXColor}" is not valid HEX color.`);
 
-            const { css, theme2x } = getThemeCSSFromColor(this.id, color);
+        if (this.id === undefined) return;
 
-            this.styleTag.innerHTML = css;
-            this.styleTag.setAttribute("dc-theme", theme2x);
-        } else throw Error(`"${HEXColor}" is not valid HEX color.`);
+        const { css, theme2x } = getThemeCSSFromColor(this.id, color);
+        this.styleTag.innerHTML = css;
+        this.styleTag.setAttribute("dc-color", color);
+        this.styleTag.setAttribute("dc-theme", theme2x);
     }
 
     /**
@@ -116,7 +116,7 @@ export function create(name: string, HEXColor: string): DynamicColors {
 /**
  * Removes a DynamicColors instance.
  * @param {DynamicColors | string} dcTagInstanceOrName The DynamicColors `instance` or `name` to remove.
- * @returns {Promise<boolean>} `true` if the instance is removed, `false` otherwise.
+ * @returns {Promise<boolean>} `true` if the instance is removed, otherwise `false`.
  */
 export async function remove(
     dcTagInstanceOrName: DynamicColors | string
@@ -138,3 +138,13 @@ export async function remove(
         return false;
     }
 }
+
+/**
+ * Determines whether the given object is an instance of `DynamicColors`.
+ *
+ * @param {unknown} object The object to check.
+ * @returns {boolean} Returns `true` if the object is an instance of `DynamicColors`, otherwise `false`.
+ */
+export function isInstance(object: unknown): boolean {
+    return object instanceof DynamicColors;
+}

package.json

@@ -4,4 +4,4 @@ export {
     setLightTheme,
     themeCycle,
 } from "./OSTheme";
-export { create, remove } from "./dynamicColors";
+export { create, isInstance, remove } from "./dynamicColors";

src/dynamicColors.ts

@@ -18,7 +18,7 @@ export function addInstance(dynamicColors: DynamicColors) {
 /**
  * Removes a DynamicColors instance from the instances array and removes its associated HTML element.
  * @param {DynamicColors} dynamicColors The DynamicColors instance to remove.
- * @returns {boolean} `true` if the instance is removed, `false` otherwise.
+ * @returns {boolean} `true` if the instance is removed, otherwise `false`.
  */
 export function removeInstance(dynamicColors: DynamicColors): boolean {
     if (dynamicColors.dcID !== undefined && isLocked(dynamicColors.dcID))

src/index.ts

@@ -20,7 +20,7 @@ export function removeLock(DynamicColorsID: string) {
 /**
  * Check if DynamicColors instance is locked or not.
  * @param DynamicColorsID
- * @returns {boolean} `true` if instance is locked, `false` otherwise.
+ * @returns {boolean} `true` if instance is locked, otherwise `false`.
  */
 export function isLocked(DynamicColorsID: string): boolean {
     let lock = lockList.includes(DynamicColorsID);

src/instances.ts

@@ -1,7 +1,7 @@
 /**
  * Validates a HEX color value.
  * @param {string} color The color value to validate.
- * @returns {string | false} The validated color value if it is a valid HEX color, or `false` otherwise.
+ * @returns {string | false} The validated color value if it is a valid HEX color, or otherwise `false`.
  */
 export function validateHEXColor(color: string): string | false {
     if (/^#([0-9A-Fa-f]{3}){1,2}$/i.test(color)) return color.toLowerCase();

src/lockMechanism.ts

@@ -5,13 +5,8 @@
         "module": "ES6",
         "rootDir": "./src",
         "allowJs": true,
-        "declaration": true,
         "outDir": "./lib",
-        "strict": true,
-        "moduleResolution": "nodenext"
-        // "esModuleInterop": true,
-        // "forceConsistentCasingInFileNames": true,
-        // "skipLibCheck": true
+        "strict": true
     },
     "include": ["src"],
     "exclude": ["node_modules", "test"]