@dereekb/browser 13.4.0 → 13.4.2

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();
@@ -401,6 +407,8 @@ 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.
+ *
+ * @param cssVariableName - Name of the CSS custom property to update; defaults to `vh100`
  */ function watchWindowAndUpdateVh100StyleProperty(cssVariableName) {
     var refreshPropertyValue = refreshVh100Function(cssVariableName);
     window.addEventListener('resize', refreshPropertyValue);
@@ -411,6 +419,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();
@@ -399,6 +405,8 @@ 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.
+ *
+ * @param cssVariableName - Name of the CSS custom property to update; defaults to `vh100`
  */ function watchWindowAndUpdateVh100StyleProperty(cssVariableName) {
     var refreshPropertyValue = refreshVh100Function(cssVariableName);
     window.addEventListener('resize', refreshPropertyValue);
@@ -409,6 +417,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.0",
+  "version": "13.4.2",
   "peerDependencies": {
-    "@dereekb/util": "13.4.0",
-    "@dereekb/rxjs": "13.4.0",
+    "@dereekb/util": "13.4.2",
+    "@dereekb/rxjs": "13.4.2",
     "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

@@ -20,5 +20,7 @@ export declare const DEFAULT_VH100_VARIABLE_NAME = "vh100";
 export declare function refreshVh100Function(cssVariableName?: string): () => void;
 /**
  * Adds window event listeners to populate the css variable `vh100`, or another input variable name, with the current window height.
+ *
+ * @param cssVariableName - Name of the CSS custom property to update; defaults to `vh100`
  */
 export declare function watchWindowAndUpdateVh100StyleProperty(cssVariableName?: string): 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;
 /**