@ouroboros/browser 0.5.4 → 0.5.6

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ouroboros/browser",
-	"version": "0.5.4",
+	"version": "0.5.6",
 	"description": "Package to handle common browser functionality.",
 	"main": "index.js",
 	"types": "index.d.ts",
@@ -33,10 +33,9 @@
 	"devDependencies": {
 		"tslint": "^6.1.3",
 		"tslint-config-prettier": "^1.18.0",
-		"typescript": "^4.8.3"
+		"typescript": "^5.9.2"
 	},
 	"dependencies": {
-		"@ouroboros/clone": "^1.1.0",
 		"@ouroboros/subscribe": "^1.3.2",
 		"@ouroboros/tools": "^0.7.1"
 	}

package/pageVisibility.d.ts

@@ -17,6 +17,7 @@ import Subscribe, { SubscribeCallback, SubscribeReturn } from '@ouroboros/subscr
  * @extends Subscribe
  */
 declare class PageVisibility extends Subscribe {
+    #private;
     /**
      * Constructor
      *
@@ -27,6 +28,17 @@ declare class PageVisibility extends Subscribe {
      * @returns PageVisibility
      */
     constructor();
+    /**
+     * Set
+     *
+     * Overrides Subscribe.set to make sure no one can call it without a failure
+     *
+     * @name set
+     * @access public
+     * @param data The new data to set and then send
+     * @returns void
+     */
+    set(data: any): boolean;
     /**
      * Subscribe
      *

package/pageVisibility.js

@@ -35,22 +35,6 @@ else {
         }
     }
 }
-/**
- * Track
- *
- * The actual function passed to the event so that we only have one event
- * listener
- *
- * @name track
- * @access private
- */
-function track() {
-    // Set the data so the instance notifies subscribers
-    pageVisibility.set({
-        property: document[properties.property],
-        state: document[properties.state]
-    });
-}
 /**
  * Page Visibility
  *
@@ -76,6 +60,19 @@ class PageVisibility extends Subscribe {
             state: document[properties.state]
         } : null);
     }
+    /**
+     * Set
+     *
+     * Overrides Subscribe.set to make sure no one can call it without a failure
+     *
+     * @name set
+     * @access public
+     * @param data The new data to set and then send
+     * @returns void
+     */
+    set(data) {
+        throw new Error('Calling PageVisibility.set() is forbidden');
+    }
     /**
      * Subscribe
      *
@@ -90,11 +87,27 @@ class PageVisibility extends Subscribe {
         // If we have no current subscribers
         if (apiAvailable && this.subscribeCallbacks.length === 0) {
             // Add the event listener
-            document.addEventListener(properties.event, track);
+            document.addEventListener(properties.event, this.#track);
         }
         // Call the parent subscribe and return
         return super.subscribe(callback);
     }
+    /**
+     * Track
+     *
+     * The actual function passed to the event so that we only have one event
+     * listener
+     *
+     * @name track
+     * @access private
+     */
+    #track = () => {
+        // Set the data so the instance notifies subscribers
+        super.set({
+            property: document[properties.property],
+            state: document[properties.state]
+        });
+    };
     /**
      * Unsubscribe
      *
@@ -115,7 +128,7 @@ class PageVisibility extends Subscribe {
         // If it was successful and we have no more callbacks
         if (bRet && this.subscribeCallbacks.length === 0) {
             // Remove the event listener
-            document.removeEventListener(properties.event, track);
+            document.removeEventListener(properties.event, this.#track);
         }
         // Return
         return bRet;

package/size.d.ts

@@ -65,6 +65,18 @@ declare class Size extends Subscribe {
      * @returns number
      */
     greaterThan(against: SIZE): boolean;
+    /**
+     * Greater Than or Equal
+     *
+     * Calls the module's `greaterThanOrEqual` method with the current size and
+     * the `against` param.
+     *
+     * @name greaterThanOrEqual
+     * @access public
+     * @param against The size to compare the current size against
+     * @returns number
+     */
+    greaterThanOrEqual(against: SIZE): boolean;
     /**
      * Less Than
      *
@@ -77,6 +89,18 @@ declare class Size extends Subscribe {
      * @returns number
      */
     lessThan(against: SIZE): boolean;
+    /**
+     * Less Than or Equal
+     *
+     * Calls the module's `lessThanOrEqual` method with the current size and
+     * the `against` param.
+     *
+     * @name lessThanOrEqual
+     * @access public
+     * @param against The size to compare the current size against
+     * @returns number
+     */
+    lessThanOrEqual(against: SIZE): boolean;
     /**
      * Subscribe
      *
@@ -127,6 +151,18 @@ export declare function compare(a: SIZE, b: SIZE): 0 | 1 | -1;
  * @returns boolean
  */
 export declare function greaterThan(a: SIZE, b: SIZE): boolean;
+/**
+ * Greater Than or Equal
+ *
+ * Returns true only if `a` is a larger or equal width to `b`
+ *
+ * @name greaterThanOrEqual
+ * @access public
+ * @param a The size to compare as greater than or equal to `b`
+ * @param b The size to compare against `a`
+ * @returns boolean
+ */
+export declare function greaterThanOrEqual(a: SIZE, b: SIZE): boolean;
 /**
  * Less Than
  *
@@ -139,3 +175,15 @@ export declare function greaterThan(a: SIZE, b: SIZE): boolean;
  * @returns boolean
  */
 export declare function lessThan(a: SIZE, b: SIZE): boolean;
+/**
+ * Less Than or Equal
+ *
+ * Returns true only if `a` is a smaller or equal width to `b`
+ *
+ * @name lessThanOrEqual
+ * @access public
+ * @param a The size to compare as less than or equal to `b`
+ * @param b The size to compare against `a`
+ * @returns boolean
+ */
+export declare function lessThanOrEqual(a: SIZE, b: SIZE): boolean;

package/size.js

@@ -110,6 +110,20 @@ class Size extends Subscribe {
     greaterThan(against) {
         return greaterThan(this.subscribeData, against);
     }
+    /**
+     * Greater Than or Equal
+     *
+     * Calls the module's `greaterThanOrEqual` method with the current size and
+     * the `against` param.
+     *
+     * @name greaterThanOrEqual
+     * @access public
+     * @param against The size to compare the current size against
+     * @returns number
+     */
+    greaterThanOrEqual(against) {
+        return greaterThanOrEqual(this.subscribeData, against);
+    }
     /**
      * Less Than
      *
@@ -124,6 +138,20 @@ class Size extends Subscribe {
     lessThan(against) {
         return lessThan(this.subscribeData, against);
     }
+    /**
+     * Less Than or Equal
+     *
+     * Calls the module's `lessThanOrEqual` method with the current size and
+     * the `against` param.
+     *
+     * @name lessThanOrEqual
+     * @access public
+     * @param against The size to compare the current size against
+     * @returns number
+     */
+    lessThanOrEqual(against) {
+        return lessThanOrEqual(this.subscribeData, against);
+    }
     /**
      * Subscribe
      *
@@ -203,9 +231,24 @@ export function compare(a, b) {
  * @returns boolean
  */
 export function greaterThan(a, b) {
-    // If the current value is greater than the passed value
+    // If the `a` value is greater than the `b` value
     return SIZES[a] > SIZES[b];
 }
+/**
+ * Greater Than or Equal
+ *
+ * Returns true only if `a` is a larger or equal width to `b`
+ *
+ * @name greaterThanOrEqual
+ * @access public
+ * @param a The size to compare as greater than or equal to `b`
+ * @param b The size to compare against `a`
+ * @returns boolean
+ */
+export function greaterThanOrEqual(a, b) {
+    // If the `a` value is greater than or equal to the `b` value
+    return SIZES[a] >= SIZES[b];
+}
 /**
  * Less Than
  *
@@ -218,6 +261,21 @@ export function greaterThan(a, b) {
  * @returns boolean
  */
 export function lessThan(a, b) {
-    // If the `a` minimum value is less than the `b` minimum value
+    // If the `a` value is less than the `b` value
     return SIZES[a] < SIZES[b];
 }
+/**
+ * Less Than or Equal
+ *
+ * Returns true only if `a` is a smaller or equal width to `b`
+ *
+ * @name lessThanOrEqual
+ * @access public
+ * @param a The size to compare as less than or equal to `b`
+ * @param b The size to compare against `a`
+ * @returns boolean
+ */
+export function lessThanOrEqual(a, b) {
+    // If the `a` value is less than or equal to the `b` value
+    return SIZES[a] <= SIZES[b];
+}

package/src/pageVisibility.ts

@@ -45,24 +45,6 @@ else {
 	}
 }
 
-/**
- * Track
- *
- * The actual function passed to the event so that we only have one event
- * listener
- *
- * @name track
- * @access private
- */
-function track(): void {
-
-	// Set the data so the instance notifies subscribers
-	pageVisibility.set({
-		property: document[properties.property as keyof Document],
-		state: document[properties.state as keyof Document]
-	});
-}
-
 /**
  * Page Visibility
  *
@@ -91,6 +73,20 @@ class PageVisibility extends Subscribe {
 		} : null);
 	}
 
+	/**
+	 * Set
+	 *
+	 * Overrides Subscribe.set to make sure no one can call it without a failure
+	 *
+	 * @name set
+	 * @access public
+	 * @param data The new data to set and then send
+	 * @returns void
+	 */
+	set(data: any): boolean {
+		throw new Error('Calling PageVisibility.set() is forbidden');
+	}
+
 	/**
 	 * Subscribe
 	 *
@@ -107,13 +103,31 @@ class PageVisibility extends Subscribe {
 		if(apiAvailable && this.subscribeCallbacks.length === 0) {
 
 			// Add the event listener
-			document.addEventListener(properties.event, track);
+			document.addEventListener(properties.event, this.#track);
 		}
 
 		// Call the parent subscribe and return
 		return super.subscribe(callback);
 	}
 
+	/**
+	 * Track
+	 *
+	 * The actual function passed to the event so that we only have one event
+	 * listener
+	 *
+	 * @name track
+	 * @access private
+	 */
+	#track = () => {
+
+		// Set the data so the instance notifies subscribers
+		super.set({
+			property: document[properties.property as keyof Document],
+			state: document[properties.state as keyof Document]
+		});
+	}
+
 	/**
 	 * Unsubscribe
 	 *
@@ -138,7 +152,7 @@ class PageVisibility extends Subscribe {
 		if(bRet && this.subscribeCallbacks.length === 0) {
 
 			// Remove the event listener
-			document.removeEventListener(properties.event, track);
+			document.removeEventListener(properties.event, this.#track);
 		}
 
 		// Return

package/src/size.ts

@@ -120,6 +120,21 @@ class Size extends Subscribe {
 		return greaterThan(this.subscribeData, against);
 	}
 
+	/**
+	 * Greater Than or Equal
+	 *
+	 * Calls the module's `greaterThanOrEqual` method with the current size and
+	 * the `against` param.
+	 *
+	 * @name greaterThanOrEqual
+	 * @access public
+	 * @param against The size to compare the current size against
+	 * @returns number
+	 */
+	greaterThanOrEqual(against: SIZE): boolean {
+		return greaterThanOrEqual(this.subscribeData, against);
+	}
+
 	/**
 	 * Less Than
 	 *
@@ -135,6 +150,21 @@ class Size extends Subscribe {
 		return lessThan(this.subscribeData, against);
 	}
 
+	/**
+	 * Less Than or Equal
+	 *
+	 * Calls the module's `lessThanOrEqual` method with the current size and
+	 * the `against` param.
+	 *
+	 * @name lessThanOrEqual
+	 * @access public
+	 * @param against The size to compare the current size against
+	 * @returns number
+	 */
+	lessThanOrEqual(against: SIZE): boolean {
+		return lessThanOrEqual(this.subscribeData, against);
+	}
+
 	/**
 	 * Subscribe
 	 *
@@ -227,10 +257,27 @@ export function compare(a: SIZE, b: SIZE) {
  */
 export function greaterThan(a: SIZE, b: SIZE): boolean {
 
-	// If the current value is greater than the passed value
+	// If the `a` value is greater than the `b` value
 	return SIZES[a] > SIZES[b];
 }
 
+/**
+ * Greater Than or Equal
+ *
+ * Returns true only if `a` is a larger or equal width to `b`
+ *
+ * @name greaterThanOrEqual
+ * @access public
+ * @param a The size to compare as greater than or equal to `b`
+ * @param b The size to compare against `a`
+ * @returns boolean
+ */
+export function greaterThanOrEqual(a: SIZE, b: SIZE): boolean {
+
+	// If the `a` value is greater than or equal to the `b` value
+	return SIZES[a] >= SIZES[b];
+}
+
 /**
  * Less Than
  *
@@ -244,6 +291,23 @@ export function greaterThan(a: SIZE, b: SIZE): boolean {
  */
 export function lessThan(a: SIZE, b: SIZE): boolean {
 
-	// If the `a` minimum value is less than the `b` minimum value
+	// If the `a` value is less than the `b` value
 	return SIZES[a] < SIZES[b];
-}
+}
+
+/**
+ * Less Than or Equal
+ *
+ * Returns true only if `a` is a smaller or equal width to `b`
+ *
+ * @name lessThanOrEqual
+ * @access public
+ * @param a The size to compare as less than or equal to `b`
+ * @param b The size to compare against `a`
+ * @returns boolean
+ */
+export function lessThanOrEqual(a: SIZE, b: SIZE): boolean {
+
+	// If the `a` value is less than or equal to the `b` value
+	return SIZES[a] <= SIZES[b];
+}