@dereekb/browser 13.4.1 → 13.5.0

package/index.cjs.js

@@ -5,7 +5,9 @@ var rxjs$1 = require('@dereekb/rxjs');
 var rxjs = require('rxjs');
 
 /**
- * Creatse a new BrowserObjectURLRef.
+ * Creates a new BrowserObjectURLRef.
+ *
+ * @returns A new BrowserObjectURLRef instance that manages browser object URL lifecycle
  */ function browserObjectUrlRef() {
     var browserUrl;
     /**
@@ -209,7 +211,7 @@ function _ts_generator(thisArg, body) {
         /**
      * Observable that emits the loading promise. Subscribing triggers the initial load if not already started.
      */ _define_property(this, "loading$", this._loading.pipe(rxjs$1.tapFirst(function() {
-            return _this.loadService();
+            void _this.loadService();
         }), rxjs$1.filterMaybe(), rxjs.shareReplay(1)));
         /**
      * Observable that emits the resolved service instance once loading completes. Replays the last value to new subscribers.
@@ -240,6 +242,8 @@ function _ts_generator(thisArg, body) {
      * Returns a promise that resolves with the loaded service instance.
      *
      * Triggers loading if not already started.
+     *
+     * @returns Promise that resolves with the loaded service instance
      */ key: "getService",
             value: function getService() {
                 return rxjs.firstValueFrom(this.service$);
@@ -350,6 +354,8 @@ function _ts_generator(thisArg, body) {
             /**
      * Hook called before completing the service load. Subclasses can override to perform
      * additional async setup before the service reference is read from `window`.
+     *
+     * @returns Promise that resolves when pre-load setup is complete
      */ key: "_prepareCompleteLoadingService",
             value: function _prepareCompleteLoadingService() {
                 return Promise.resolve();
@@ -373,7 +379,6 @@ function _ts_generator(thisArg, body) {
 } 
 ();
 
-// https://dev.to/maciejtrzcinski/100vh-problem-with-ios-safari-3ge9
 /**
  * Default CSS custom property name used to store the viewport height value.
  */ var DEFAULT_VH100_VARIABLE_NAME = 'vh100';
@@ -383,7 +388,7 @@ function _ts_generator(thisArg, body) {
  * This is a workaround for the iOS Safari 100vh bug where `100vh` includes the browser chrome,
  * causing layout overflow. The returned function can be called to refresh the property value.
  *
- * @param cssVariableName - Name of the CSS custom property (without the `--` prefix)
+ * @param cssTokenName - Name of the CSS custom property (without the `--` prefix)
  * @returns A zero-argument function that updates the CSS property to the current inner height
  *
  * @example
@@ -392,8 +397,8 @@ function _ts_generator(thisArg, body) {
  * refresh(); // sets --vh100 to e.g. "812px"
  * ```
  */ function refreshVh100Function() {
-    var cssVariableName = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : DEFAULT_VH100_VARIABLE_NAME;
-    var cssProperty = "--".concat(cssVariableName);
+    var cssTokenName = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : DEFAULT_VH100_VARIABLE_NAME;
+    var cssProperty = "--".concat(cssTokenName);
     return function() {
         var doc = document.documentElement;
         doc.style.setProperty(cssProperty, "".concat(window.innerHeight, "px"));
@@ -401,8 +406,10 @@ function _ts_generator(thisArg, body) {
 }
 /**
  * Adds window event listeners to populate the css variable `vh100`, or another input variable name, with the current window height.
- */ function watchWindowAndUpdateVh100StyleProperty(cssVariableName) {
-    var refreshPropertyValue = refreshVh100Function(cssVariableName);
+ *
+ * @param cssTokenName - Name of the CSS custom property to update; defaults to `vh100`
+ */ function watchWindowAndUpdateVh100StyleProperty(cssTokenName) {
+    var refreshPropertyValue = refreshVh100Function(cssTokenName);
     window.addEventListener('resize', refreshPropertyValue);
     window.addEventListener('orientationchange', refreshPropertyValue);
     refreshPropertyValue();
@@ -411,6 +418,8 @@ function _ts_generator(thisArg, body) {
 // MARK: Window Location Utiltiies
 /**
  * Whether or not the current host is localhost. Useful for determining local dev environments.
+ *
+ * @returns True if the current hostname is `localhost`
  */ function isLocalhost() {
     return window.location.hostname === 'localhost';
 }

package/index.esm.js

@@ -3,7 +3,9 @@ import { tapFirst, filterMaybe } from '@dereekb/rxjs';
 import { BehaviorSubject, shareReplay, switchMap, from, firstValueFrom } from 'rxjs';
 
 /**
- * Creatse a new BrowserObjectURLRef.
+ * Creates a new BrowserObjectURLRef.
+ *
+ * @returns A new BrowserObjectURLRef instance that manages browser object URL lifecycle
  */ function browserObjectUrlRef() {
     var browserUrl;
     /**
@@ -207,7 +209,7 @@ function _ts_generator(thisArg, body) {
         /**
      * Observable that emits the loading promise. Subscribing triggers the initial load if not already started.
      */ _define_property(this, "loading$", this._loading.pipe(tapFirst(function() {
-            return _this.loadService();
+            void _this.loadService();
         }), filterMaybe(), shareReplay(1)));
         /**
      * Observable that emits the resolved service instance once loading completes. Replays the last value to new subscribers.
@@ -238,6 +240,8 @@ function _ts_generator(thisArg, body) {
      * Returns a promise that resolves with the loaded service instance.
      *
      * Triggers loading if not already started.
+     *
+     * @returns Promise that resolves with the loaded service instance
      */ key: "getService",
             value: function getService() {
                 return firstValueFrom(this.service$);
@@ -348,6 +352,8 @@ function _ts_generator(thisArg, body) {
             /**
      * Hook called before completing the service load. Subclasses can override to perform
      * additional async setup before the service reference is read from `window`.
+     *
+     * @returns Promise that resolves when pre-load setup is complete
      */ key: "_prepareCompleteLoadingService",
             value: function _prepareCompleteLoadingService() {
                 return Promise.resolve();
@@ -371,7 +377,6 @@ function _ts_generator(thisArg, body) {
 } 
 ();
 
-// https://dev.to/maciejtrzcinski/100vh-problem-with-ios-safari-3ge9
 /**
  * Default CSS custom property name used to store the viewport height value.
  */ var DEFAULT_VH100_VARIABLE_NAME = 'vh100';
@@ -381,7 +386,7 @@ function _ts_generator(thisArg, body) {
  * This is a workaround for the iOS Safari 100vh bug where `100vh` includes the browser chrome,
  * causing layout overflow. The returned function can be called to refresh the property value.
  *
- * @param cssVariableName - Name of the CSS custom property (without the `--` prefix)
+ * @param cssTokenName - Name of the CSS custom property (without the `--` prefix)
  * @returns A zero-argument function that updates the CSS property to the current inner height
  *
  * @example
@@ -390,8 +395,8 @@ function _ts_generator(thisArg, body) {
  * refresh(); // sets --vh100 to e.g. "812px"
  * ```
  */ function refreshVh100Function() {
-    var cssVariableName = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : DEFAULT_VH100_VARIABLE_NAME;
-    var cssProperty = "--".concat(cssVariableName);
+    var cssTokenName = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : DEFAULT_VH100_VARIABLE_NAME;
+    var cssProperty = "--".concat(cssTokenName);
     return function() {
         var doc = document.documentElement;
         doc.style.setProperty(cssProperty, "".concat(window.innerHeight, "px"));
@@ -399,8 +404,10 @@ function _ts_generator(thisArg, body) {
 }
 /**
  * Adds window event listeners to populate the css variable `vh100`, or another input variable name, with the current window height.
- */ function watchWindowAndUpdateVh100StyleProperty(cssVariableName) {
-    var refreshPropertyValue = refreshVh100Function(cssVariableName);
+ *
+ * @param cssTokenName - Name of the CSS custom property to update; defaults to `vh100`
+ */ function watchWindowAndUpdateVh100StyleProperty(cssTokenName) {
+    var refreshPropertyValue = refreshVh100Function(cssTokenName);
     window.addEventListener('resize', refreshPropertyValue);
     window.addEventListener('orientationchange', refreshPropertyValue);
     refreshPropertyValue();
@@ -409,6 +416,8 @@ function _ts_generator(thisArg, body) {
 // MARK: Window Location Utiltiies
 /**
  * Whether or not the current host is localhost. Useful for determining local dev environments.
+ *
+ * @returns True if the current hostname is `localhost`
  */ function isLocalhost() {
     return window.location.hostname === 'localhost';
 }

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@dereekb/browser",
-  "version": "13.4.1",
+  "version": "13.5.0",
   "peerDependencies": {
-    "@dereekb/util": "13.4.1",
-    "@dereekb/rxjs": "13.4.1",
+    "@dereekb/util": "13.5.0",
+    "@dereekb/rxjs": "13.5.0",
     "rxjs": "^7.8.0"
   },
   "dependencies": {},

package/src/lib/service.d.ts

@@ -48,6 +48,8 @@ export declare abstract class AbstractAsyncWindowLoadedService<T> implements Des
      * Returns a promise that resolves with the loaded service instance.
      *
      * Triggers loading if not already started.
+     *
+     * @returns Promise that resolves with the loaded service instance
      */
     getService(): Promise<T>;
     /**
@@ -71,6 +73,8 @@ export declare abstract class AbstractAsyncWindowLoadedService<T> implements Des
     /**
      * Hook called before completing the service load. Subclasses can override to perform
      * additional async setup before the service reference is read from `window`.
+     *
+     * @returns Promise that resolves when pre-load setup is complete
      */
     protected _prepareCompleteLoadingService(): Promise<unknown>;
     /**

package/src/lib/type.d.ts

@@ -23,6 +23,8 @@ export interface BrowserObjectURLRef extends Destroyable {
     createBrowserUrl(input?: Maybe<Blob | MediaSource>): Maybe<BrowserObjectURL>;
 }
 /**
- * Creatse a new BrowserObjectURLRef.
+ * Creates a new BrowserObjectURLRef.
+ *
+ * @returns A new BrowserObjectURLRef instance that manages browser object URL lifecycle
  */
 export declare function browserObjectUrlRef(): BrowserObjectURLRef;

package/src/lib/vh100.d.ts

@@ -1,14 +1,15 @@
+import { type CssTokenName } from '@dereekb/util';
 /**
  * Default CSS custom property name used to store the viewport height value.
  */
-export declare const DEFAULT_VH100_VARIABLE_NAME = "vh100";
+export declare const DEFAULT_VH100_VARIABLE_NAME: CssTokenName;
 /**
  * Creates a function that sets a CSS custom property on `document.documentElement` to the current `window.innerHeight` in pixels.
  *
  * This is a workaround for the iOS Safari 100vh bug where `100vh` includes the browser chrome,
  * causing layout overflow. The returned function can be called to refresh the property value.
  *
- * @param cssVariableName - Name of the CSS custom property (without the `--` prefix)
+ * @param cssTokenName - Name of the CSS custom property (without the `--` prefix)
  * @returns A zero-argument function that updates the CSS property to the current inner height
  *
  * @example
@@ -17,8 +18,10 @@ export declare const DEFAULT_VH100_VARIABLE_NAME = "vh100";
  * refresh(); // sets --vh100 to e.g. "812px"
  * ```
  */
-export declare function refreshVh100Function(cssVariableName?: string): () => void;
+export declare function refreshVh100Function(cssTokenName?: CssTokenName): () => void;
 /**
  * Adds window event listeners to populate the css variable `vh100`, or another input variable name, with the current window height.
+ *
+ * @param cssTokenName - Name of the CSS custom property to update; defaults to `vh100`
  */
-export declare function watchWindowAndUpdateVh100StyleProperty(cssVariableName?: string): void;
+export declare function watchWindowAndUpdateVh100StyleProperty(cssTokenName?: CssTokenName): void;

package/src/lib/window.d.ts

@@ -1,5 +1,7 @@
 /**
  * Whether or not the current host is localhost. Useful for determining local dev environments.
+ *
+ * @returns True if the current hostname is `localhost`
  */
 export declare function isLocalhost(): boolean;
 /**