@cripty2001/utils 0.0.218 → 0.0.220

package/dist/react-whispr.d.ts

@@ -205,3 +205,34 @@ export declare function useAsyncInput<C extends Record<string, JSONEncodable>, R
     setValue: (updater: (draft: C) => C | void) => void,
     result: R | null
 ];
+/**
+ * Creates a Whispr from an external (non-reactive) data source.
+ *
+ * Unlike `Whispr.from`, which derives state from other Whisprs, this function
+ * bridges an arbitrary data generator into Whispr's reactive system — useful
+ * when your source of truth lives outside the Whispr graph (e.g. a DOM API,
+ * a global store, or a plain function).
+ *
+ * @param getData - A function that returns the current value of the external source.
+ *                  Called once immediately to seed the Whispr, then on every refresh.
+ * @param interval - If provided, the Whispr will automatically re-poll `getData`
+ *                   every `interval` milliseconds. Pass `null` to disable auto-refresh.
+ * @returns An object with:
+ *   - `data`: The resulting `Whispr<T>`, seeded with the initial value from `getData`.
+ *   - `refresh`: A function that manually re-reads `getData` and pushes the new
+ *     value into the Whispr. Hook this wherever you have a hint that the
+ *     external source may have changed.
+ *
+ * @example
+ * const { data: windowSize, refresh: refreshSize } = whisprFromExternal(
+ *   () => ({ width: window.innerWidth, height: window.innerHeight }),
+ *   null,
+ * );
+ *
+ * window.addEventListener("resize", refreshSize);
+ */
+export type WhisprFromExternalResult<T> = {
+    data: Whispr<T>;
+    refresh: () => void;
+};
+export declare function whisprFromExternal<T>(getData: () => T, interval: number | null): WhisprFromExternalResult<T>;

package/dist/react-whispr.js

@@ -13,6 +13,7 @@ exports.useRelTime = useRelTime;
 exports.useSearcher = useSearcher;
 exports.useSafeRef = useSafeRef;
 exports.useAsyncInput = useAsyncInput;
+exports.whisprFromExternal = whisprFromExternal;
 const whispr_1 = require("@cripty2001/whispr");
 const react_1 = require("react");
 const lodash_1 = require("lodash");
@@ -438,32 +439,6 @@ function useAsyncInput(value, setValue, handler, setPending = () => { }) {
         result,
     ];
 }
-/**
- * Creates a Whispr from an external (non-reactive) data source.
- *
- * Unlike `Whispr.from`, which derives state from other Whisprs, this function
- * bridges an arbitrary data generator into Whispr's reactive system — useful
- * when your source of truth lives outside the Whispr graph (e.g. a DOM API,
- * a global store, or a plain function).
- *
- * @param getData - A function that returns the current value of the external source.
- *                  Called once immediately to seed the Whispr, then on every refresh.
- * @param interval - If provided, the Whispr will automatically re-poll `getData`
- *                   every `interval` milliseconds. Pass `null` to disable auto-refresh.
- * @returns A tuple of:
- *   - The resulting `Whispr<T>`, seeded with the initial value from `getData`.
- *   - A `refresh` function that manually re-reads `getData` and pushes the new
- *     value into the Whispr. Hook this wherever you have a hint that the
- *     external source may have changed.
- *
- * @example
- * const [windowSize, refreshSize] = whisprFromExternal(
- *   () => ({ width: window.innerWidth, height: window.innerHeight }),
- *   null,
- * );
- *
- * window.addEventListener("resize", refreshSize);
- */
 function whisprFromExternal(getData, interval) {
     const intervalRef = (() => {
         return interval !== null ?
@@ -478,5 +453,8 @@ function whisprFromExternal(getData, interval) {
         }
     };
     const [value, setValue] = whispr_1.Whispr.create(getData(), cleanup);
-    return [value, () => setValue(getData())];
+    return {
+        data: value,
+        refresh: () => setValue(getData()),
+    };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cripty2001/utils",
-  "version": "0.0.218",
+  "version": "0.0.220",
   "description": "Internal Set of utils. If you need them use them, otherwise go to the next package ;)",
   "homepage": "https://github.com/cripty2001/utils#readme",
   "bugs": {