fix type usePromise

atomicojs · Apr 10, 2022 · fb9a377 · fb9a377
1 parent 409de20
commit fb9a377
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@atomico/hooks",
   "description": "Series of utilities in hooks format to extend the operation of Atomico",
-  "version": "3.33.4",
+  "version": "3.33.5",
   "type": "module",
   "workspaces": [
     "src/**/*"

diff --git a/src/use-promise/use-promise.js b/src/use-promise/use-promise.js
@@ -14,15 +14,16 @@ export const Status = {
  */
 const initalState = () => [, ""];
 /**
+ * @template {()=>Promise<any>} T
  * @example
  * ```js
  * const [executePromise, setExecutePromise] = useState();
  * const [ result, status ] = usePromise(()=>fetch("./any").then(res=>res.json()),executePromise);
  * ```
- * @param {()=>Promise<any>} promise -
+ * @param {T} promise -
  * @param {boolean} run
  * @param {any[]} [args]
- * @returns {State}
+ * @returns {T extends (...args:any[])=>Promise<infer R> ?  State<R>  :  State<any> }
  */
 export function usePromise(promise, run, args = []) {
   const [state, setState] = useState(initalState);
@@ -50,7 +51,10 @@ export function usePromise(promise, run, args = []) {
 
 /**@typedef {Status["quiet"]|Status["pending"]|Status["fulfilled"]|Status["rejected"]} PromiseStatus */
 
-/**@typedef {[any,PromiseStatus]} State */
+/**
+ * @template T
+ * @typedef {[T,PromiseStatus]} State
+ **/
 
 /**
  * @typedef {Object} Status