@tamagui/use-debounce 1.124.17 → 1.124.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tamagui/use-debounce",
-  "version": "1.124.17",
+  "version": "1.124.18",
   "types": "./types/index.d.ts",
   "main": "dist/cjs",
   "module": "dist/esm",
@@ -31,7 +31,7 @@
     }
   },
   "devDependencies": {
-    "@tamagui/build": "1.124.17",
+    "@tamagui/build": "1.124.18",
     "react": "*"
   },
   "publishConfig": {

package/types/index.d.ts

@@ -1,16 +1,14 @@
-type DebounceSettings = {
-    leading?: boolean;
-};
-export declare function debounce<A extends Function>(func: A, wait?: number, leading?: boolean): A & {
-    cancel: () => void;
-};
-export declare function useDebounce<A extends (...args: any) => any | undefined | null, DebouncedFn extends A & {
-    cancel: () => void;
-}>(fn: A, wait: number, options?: DebounceSettings, mountArgs?: any[]): DebouncedFn;
+type DebounceSettings = { leading?: boolean };
+export declare function debounce<A extends Function>(func: A, wait?: number, leading?: boolean): A & { cancel: () => void };
+export declare function useDebounce<
+	A extends (...args: any) => any | undefined | null,
+	DebouncedFn extends A & { cancel: () => void }
+>(fn: A, wait: number, options?: DebounceSettings, mountArgs?: any[]): DebouncedFn;
 /**
- * Returns a value once it stops changing after "amt" time.
- * Note: you may need to memo or this will keep re-rendering
- */
+* Returns a value once it stops changing after "amt" time.
+* Note: you may need to memo or this will keep re-rendering
+*/
 export declare function useDebounceValue<A>(val: A, amt?: number): A;
 export {};
+
 //# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +1,20 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,KAAK,gBAAgB,GAAG;IACtB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAID,wBAAgB,QAAQ,CAAC,CAAC,SAAS,QAAQ,EACzC,IAAI,EAAE,CAAC,EACP,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,GAChB,CAAC,GAAG;IACL,MAAM,EAAE,MAAM,IAAI,CAAA;CACnB,CAyBA;AAID,wBAAgB,WAAW,CACzB,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,GAAG,SAAS,GAAG,IAAI,EAClD,WAAW,SAAS,CAAC,GAAG;IACtB,MAAM,EAAE,MAAM,IAAI,CAAA;CACnB,EAED,EAAE,EAAE,CAAC,EACL,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,gBAA8B,EACvC,SAAS,GAAE,GAAG,EAAS,GACtB,WAAW,CAab;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,SAAI,GAAG,CAAC,CAiBtD"}
+{
+  "mappings": "KAEK,mBAAmB,EACtB,kBACD;AAID,OAAO,iBAAS,SAAS,UAAU,UACjCA,MAAM,GACNC,eACAC,oBACC,IAAI,EACL,mBACD;AA6BD,OAAO,iBAAS;CACd,WAAW,GAAG,gCAAgC;CAC9C,oBAAoB,IAAI,EACtB,mBACD;EAEDC,IAAI,GACJC,cACAC,UAAS,kBACTC,oBACC;;;;;AAmBH,OAAO,iBAAS,iBAAiB,GAAGC,KAAK,GAAG,eAAU",
+  "names": [
+    "func: A",
+    "wait?: number",
+    "leading?: boolean",
+    "fn: A",
+    "wait: number",
+    "options: DebounceSettings",
+    "mountArgs: any[]",
+    "val: A"
+  ],
+  "sources": [
+    "src/index.ts"
+  ],
+  "sourcesContent": [
+    "import * as React from 'react'\n\ntype DebounceSettings = {\n  leading?: boolean\n}\n\n// TODO doesn't return value of the function called :/\n\nexport function debounce<A extends Function>(\n  func: A,\n  wait?: number,\n  leading?: boolean\n): A & {\n  cancel: () => void\n} {\n  let timeout: any\n  let isCancelled = false\n\n  function debounced(this: any) {\n    isCancelled = false\n    const args = arguments\n    if (leading && !timeout) {\n      func.apply(this, args)\n    }\n    clearTimeout(timeout)\n    timeout = setTimeout(() => {\n      timeout = null\n      if (!(leading || isCancelled)) {\n        func.apply(this, args)\n      }\n      isCancelled = false\n    }, wait)\n  }\n\n  debounced.cancel = () => {\n    isCancelled = true\n  }\n\n  return debounced as any\n}\n\nconst defaultOpts = { leading: false }\n\nexport function useDebounce<\n  A extends (...args: any) => any | undefined | null,\n  DebouncedFn extends A & {\n    cancel: () => void\n  },\n>(\n  fn: A,\n  wait: number,\n  options: DebounceSettings = defaultOpts,\n  mountArgs: any[] = [fn]\n): DebouncedFn {\n  const dbEffect = React.useRef<DebouncedFn | null>(null)\n\n  React.useEffect(() => {\n    return () => {\n      dbEffect.current?.cancel()\n    }\n  }, [])\n\n  return React.useMemo(() => {\n    dbEffect.current = debounce(fn, wait, options.leading) as unknown as DebouncedFn\n    return dbEffect.current\n  }, [options.leading, ...mountArgs])\n}\n\n/**\n * Returns a value once it stops changing after \"amt\" time.\n * Note: you may need to memo or this will keep re-rendering\n */\nexport function useDebounceValue<A>(val: A, amt = 0): A {\n  const [state, setState] = React.useState(val)\n\n  React.useEffect(() => {\n    const tm = setTimeout(() => {\n      setState((prev) => {\n        if (prev === val) return prev\n        return val\n      })\n    }, amt)\n\n    return () => {\n      clearTimeout(tm)\n    }\n  }, [val])\n\n  return state\n}\n"
+  ],
+  "version": 3
+}